c8y-nitro 0.1.0 → 0.1.1

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/system-options/SystemOptionsService.mjs

@@ -0,0 +1,82 @@
+import { __awaiter } from "../../../../../../../../tslib@2.8.1/node_modules/tslib/tslib.es6.mjs";
+import { Service } from "../core/Service.mjs";
+import "../core/index.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/system-options/SystemOptionsService.js
+var SystemOptionsService = class extends Service {
+	constructor() {
+		super(...arguments);
+		this.baseUrl = "tenant/system";
+		this.listUrl = "options";
+		this.propertyName = "options";
+	}
+	/**
+	* Gets the details of given system option.
+	*
+	* @param {string|number|IIdentified} option System option object with mandantory fragments.
+	*
+	* @returns Response wrapped in [[IResult]]
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const option: ISystemOption = {
+	*      category: 'alarm.type.mapping',
+	*      key: 'temp_to_high'
+	*    };
+	*
+	*    (async () => {
+	*      const {data, res} = await systemOptionsService.detail(option);
+	*   })();
+	* ```
+	*/
+	detail(option) {
+		const _super = Object.create(null, { detail: { get: () => super.detail } });
+		return __awaiter(this, void 0, void 0, function* () {
+			return _super.detail.call(this, option);
+		});
+	}
+	/**
+	* Gets the list of system options filtered by parameters.
+	*
+	* @returns Response wrapped in [[IResultList]]
+	*
+	* @param {object} filter Object containing filters for querying system options.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const filter: object = {
+	*     pageSize: 100,
+	*     withTotalPages: true
+	*   };
+	*
+	*   (async () => {
+	*     const {data, res, paging} = await systemOptionsService.list(filter);
+	*   })();
+	* ```
+	*/
+	list() {
+		return __awaiter(this, arguments, void 0, function* (filter = {}) {
+			const headers = { "content-type": "application/json" };
+			const url = this.listUrl;
+			const res = yield this.fetch(url, {
+				headers,
+				params: filter
+			});
+			return {
+				res,
+				data: (yield res.json())[this.propertyName]
+			};
+		});
+	}
+	getDetailUrl(option) {
+		return `${this.listUrl}/${option.category}/${option.key}`;
+	}
+	onBeforeCreate(obj) {
+		return obj;
+	}
+};
+
+//#endregion
+export { SystemOptionsService };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/system-options/index.mjs

@@ -0,0 +1,3 @@
+import { SystemOptionsService } from "./SystemOptionsService.mjs";
+
+export {  };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/tenant/TenantService.mjs

@@ -0,0 +1,373 @@
+import { __awaiter } from "../../../../../../../../tslib@2.8.1/node_modules/tslib/tslib.es6.mjs";
+import { Service } from "../core/Service.mjs";
+import "../core/index.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/tenant/TenantService.js
+/**
+* @description
+* This service allows for managing tenants.
+*/
+var TenantService = class extends Service {
+	constructor() {
+		super(...arguments);
+		this.baseUrl = "tenant";
+		this.listUrl = "tenants";
+		this.currentTenantUrl = "currentTenant";
+		this.propertyName = "tenants";
+		this.fetchOptions = {
+			method: "PUT",
+			body: "{}",
+			headers: {
+				"content-type": "application/json",
+				accept: "application/json"
+			}
+		};
+	}
+	/**
+	* Get a representation of a tenant.
+	*
+	* @param {string|number|IIdentified} entityOrId Tenant's id or tenant object.
+	*
+	* @returns Returns promise object that is resolved with the IIdentified wrapped by IResult.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const tenantId: number = 1;
+	*
+	*    (async () => {
+	*      const {data, res} = await tenantService.detail(tenantId);
+	*   })();
+	* ```
+	*
+	* Required role: ROLE_TENANT_MANAGEMENT_READ<br><br>
+	* User password is never returned in GET response. Authentication mechanism is provided by another interface.
+	*/
+	detail(entityOrId) {
+		const _super = Object.create(null, { detail: { get: () => super.detail } });
+		return __awaiter(this, void 0, void 0, function* () {
+			return _super.detail.call(this, entityOrId);
+		});
+	}
+	/**
+	* Creates a new tenant.
+	*
+	* @param {IIdentified} entity Tenant object.
+	*
+	* @returns {IResult<IIdentified>} Returns promise object that is resolved with the details of newly created tenant.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const tenantObject = {
+	*    id: "sample_tenant",
+	*    company: "sample_company",
+	*    domain: "sample_domain.com",
+	*    contactName: "Mr. Doe",
+	*    ...
+	*  };
+	*
+	*  (async () => {
+	*    const {data, res} = await tenantService.create(tenantObject);
+	*  })();
+	* ```
+	*
+	* Required role: ROLE_TENANT_MANAGEMENT_ADMIN or ROLE_TENANT_MANAGEMENT_CREATE<br><br>
+	* Note that creating a tenant with adminName, adminPass and adminEmail, creates an admin user with these settings.
+	* For the tenant id SQL keywords (e.g., select, cross, where) are not allowed.
+	*/
+	create(entity) {
+		const _super = Object.create(null, { create: { get: () => super.create } });
+		return __awaiter(this, void 0, void 0, function* () {
+			return _super.create.call(this, entity);
+		});
+	}
+	/**
+	* Updates tenant data.
+	*
+	* @param {IIdentified} entity Tenant is partially updatable.
+	*
+	* @returns {IResult<IIdentified>} Returns promise object that is resolved with the saved tenant object.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const partialUpdateObject: IIdentified = {
+	*     adminName : "newAdmin"
+	*     ...
+	*   }
+	*
+	*  (async () => {
+	*    const {data, res} = await tenantService.update(partialUpdateObject);
+	*  })();
+	* ```
+	*
+	* Required role: ROLE_TENANT_MANAGEMENT_ADMIN or ROLE_TENANT_MANAGEMENT_UPDATE<br><br>
+	* Note that updating adminPass and adminEmail updates these settings in the admin user of the tenant.
+	* Updating adminName has no effect.
+	*/
+	update(entity) {
+		const _super = Object.create(null, { update: { get: () => super.update } });
+		return __awaiter(this, void 0, void 0, function* () {
+			return _super.update.call(this, entity);
+		});
+	}
+	/**
+	* Gets the list of tenants filtered by parameters.
+	*
+	* @param {object} filter Object containing filters for querying tenants.
+	*
+	* @returns Returns promise object that is resolved with the IIdentified wrapped by IResultList.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const filter: object = {
+	*     severity: Severity.MAJOR,
+	*     pageSize: 100,
+	*     withTotalPages: true
+	*   };
+	*
+	*   (async () => {
+	*     const {data, res, paging} = await tenantService.list(filter);
+	*   })();
+	* ```
+	*
+	* Required role: ROLE_TENANT_MANAGEMENT_READ
+	*/
+	list() {
+		const _super = Object.create(null, { list: { get: () => super.list } });
+		return __awaiter(this, arguments, void 0, function* (filter = {}) {
+			return _super.list.call(this, filter);
+		});
+	}
+	/**
+	* Delete a representation of a tenant.
+	*
+	* @param {string|number|IIdentified} entityOrId Tenant's id or tenant object.
+	*
+	* @returns Returns promise object that is resolved with the IResult.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const tenantId: string = "uniqueTenantId";
+	*
+	*    (async () => {
+	*      const {data, res} = await tenantService.delete(tenantId);
+	*   })();
+	* ```
+	*
+	* Required role: ROLE_TENANT_MANAGEMENT_ADMIN
+	*/
+	delete(entityOrId) {
+		const _super = Object.create(null, { delete: { get: () => super.delete } });
+		return __awaiter(this, void 0, void 0, function* () {
+			return _super.delete.call(this, entityOrId);
+		});
+	}
+	current() {
+		return __awaiter(this, arguments, void 0, function* (filter = {}) {
+			const res = yield this.fetch(this.currentTenantUrl, {
+				headers: { "content-type": "application/json" },
+				params: filter
+			});
+			return {
+				res,
+				data: yield res.json()
+			};
+		});
+	}
+	/**
+	* enable support user for current tenant.
+	*
+	* @returns Returns promise object that is resolved with the IResult.
+	*
+	* **Example**
+	* ```typescript
+	*    (async () => {
+	*      const {res} = await tenantService.enableSupportUser();
+	*   })();
+	* ```
+	*/
+	enableSupportUser() {
+		return __awaiter(this, void 0, void 0, function* () {
+			return {
+				res: yield this.fetch("support-user/enable", this.fetchOptions),
+				data: null
+			};
+		});
+	}
+	/**
+	* disable support user for current tenant.
+	*
+	* @returns Returns promise object that is resolved with the IResult.
+	*
+	* **Example**
+	* ```typescript
+	*    (async () => {
+	*      const {res} = await tenantService.disableSupportUser();
+	*   })();
+	* ```
+	*/
+	disableSupportUser() {
+		return __awaiter(this, void 0, void 0, function* () {
+			return {
+				res: yield this.fetch("support-user/disable", this.fetchOptions),
+				data: null
+			};
+		});
+	}
+	currentTenantType(tenant) {
+		return __awaiter(this, void 0, void 0, function* () {
+			if (!tenant) tenant = (yield this.current()).data;
+			if (tenant.customProperties && tenant.customProperties.tenantType === "TRIAL") return "TRIAL";
+			return "REGULAR";
+		});
+	}
+	/**
+	* Returns two factor-authentication settings for given tenant.
+	*
+	* @param tenant The tenant object.
+	*
+	* @returns Promise which resolves with the object with TFA settings.
+	*
+	* **Example**
+	* ```typescript
+	*   (async () => {
+	*     const currentTenant = (await tenantService.current()).data;
+	*     const currentTenantTfaSettings = await tenantService.getTfaSettings(currentTenant);
+	*
+	*     const subtenant = (await tenantService.detail('t12345')).data;
+	*     const subtenantTfaSettings = await tenantService.getTfaSettings(subtenant);
+	*   })();
+	* ```
+	*/
+	getTfaSettings(tenant) {
+		return __awaiter(this, void 0, void 0, function* () {
+			const url = `tenants/${this.getIdString(tenant)}/tfa`;
+			return yield (yield this.fetch(url)).json();
+		});
+	}
+	/**
+	* Update TFA strategy for tenant.
+	*
+	* @param tenant The tenant object.
+	* @param tfaStrategy The TFA strategy.
+	*
+	* @returns Returns promise object that is resolved with the IResult.
+	*
+	* **Example**
+	* ```typescript
+	*   (async () => {
+	*     const currentTenant = (await tenantService.current()).data;
+	*
+	*     const res = await tenantService.updateTfaStrategy(currentTenant, TfaStrategy.TOTP);
+	*   })();
+	* ```
+	*/
+	updateTfaStrategy(tenant, tfaStrategy) {
+		return __awaiter(this, void 0, void 0, function* () {
+			const url = `tenants/${this.getIdString(tenant)}/tfa`;
+			const method = "PUT";
+			const body = JSON.stringify({ strategy: tfaStrategy });
+			return {
+				res: yield this.fetch(url, {
+					method,
+					body,
+					headers: {
+						"content-type": "application/json",
+						accept: "application/json"
+					}
+				}),
+				data: null
+			};
+		});
+	}
+	/**
+	* Subscribes a given application to a given tenant.
+	*
+	* @param tenant The tenant object.
+	* @param application The application object.
+	*
+	* @returns Returns promise object that is resolved with the IResult.
+	*
+	* **Example**
+	* ```typescript
+	*     const newApp = {
+	*        name: 'New application',
+	*        type: 'HOSTED',
+	*        key: 'new-app'
+	*     };
+	*
+	*     const application = (await applicationService.create(newApp)).data;
+	*     const currentTenant = (await tenantService.current()).data;
+	*
+	*     const {data, res} = await tenantService.subscribeApplication(currentTenant, application);
+	*   })();
+	* ```
+	*/
+	subscribeApplication(tenant, application) {
+		return __awaiter(this, void 0, void 0, function* () {
+			const entityOrId = this.getIdString(tenant);
+			const applicationId = application.id;
+			const url = `tenants/${entityOrId}/applications`;
+			const method = "POST";
+			const body = JSON.stringify({ application: {
+				id: applicationId,
+				self: application.self
+			} });
+			const headers = { "content-type": this.mimeType("applicationReference") };
+			return {
+				res: yield this.fetch(url, this.changeFetchOptions({
+					method,
+					body,
+					headers
+				}, url)),
+				data: null
+			};
+		});
+	}
+	/**
+	* Unsubscribes a given application from a given tenant.
+	*
+	* @param tenant The tenant object.
+	* @param application The application object.
+	*
+	* @returns Returns promise object that is resolved with the IResult.
+	*
+	* **Example**
+	* ```typescript
+	*     const newApp = {
+	*        name: 'New application',
+	*        type: 'HOSTED',
+	*        key: 'new-app'
+	*     };
+	*
+	*     const application = (await applicationService.create(newApp)).data;
+	*     const currentTenant = (await tenantService.current()).data;
+	*     await tenantService.addApplication(currentTenant, application);
+	*
+	*     await tenantService.unsubscribeApplication(currentTenant, application);
+	*   })();
+	* ```
+	*/
+	unsubscribeApplication(tenant, application) {
+		return __awaiter(this, void 0, void 0, function* () {
+			const url = `tenants/${this.getIdString(tenant)}/applications/${application.id}`;
+			return {
+				res: yield this.fetch(url, this.changeFetchOptions({ method: "DELETE" }, url)),
+				data: null
+			};
+		});
+	}
+	getIdString(tenant) {
+		return tenant.id || tenant.name;
+	}
+	onBeforeCreate(obj) {
+		return obj;
+	}
+};
+
+//#endregion
+export { TenantService };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/tenant/TenantStatus.mjs

@@ -0,0 +1,11 @@
+import { gettext } from "../gettext.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/tenant/TenantStatus.js
+var TenantStatus;
+(function(TenantStatus) {
+	TenantStatus[TenantStatus["ACTIVE"] = gettext("ACTIVE")] = "ACTIVE";
+	TenantStatus[TenantStatus["SUSPENDED"] = gettext("SUSPENDED")] = "SUSPENDED";
+})(TenantStatus || (TenantStatus = {}));
+
+//#endregion
+export { TenantStatus };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/tenant/TfaStrategy.mjs

@@ -0,0 +1,14 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/tenant/TfaStrategy.js
+/**
+* Represents a strategy used for two-factor authentication.
+*/
+var TfaStrategy;
+(function(TfaStrategy) {
+	/** Two-factor authentication with Time-Based One Time Passwords. */
+	TfaStrategy["TOTP"] = "TOTP";
+	/** Two-factor authentication with codes sent via SMSes. */
+	TfaStrategy["SMS"] = "SMS";
+})(TfaStrategy || (TfaStrategy = {}));
+
+//#endregion
+export { TfaStrategy };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/tenant/index.mjs

@@ -0,0 +1,5 @@
+import { TenantService } from "./TenantService.mjs";
+import { TenantStatus } from "./TenantStatus.mjs";
+import { TfaStrategy } from "./TfaStrategy.mjs";
+
+export {  };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/tenant-login-options/ITenantLoginOptions.mjs

@@ -0,0 +1,29 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/tenant-login-options/ITenantLoginOptions.js
+var TenantLoginOptionType;
+(function(TenantLoginOptionType) {
+	/**
+	* OAI-Secure: authentication information is stored in a HttpOnly cookie
+	*/
+	TenantLoginOptionType["OAUTH2_INTERNAL"] = "OAUTH2_INTERNAL";
+	/**
+	* SSO redirect: allows a user to login with a single 3rd-party authorization server using the OAuth2 protocol.
+	*/
+	TenantLoginOptionType["OAUTH2"] = "OAUTH2";
+	/**
+	* Basic Auth: authentication information is stored in a session storage
+	*/
+	TenantLoginOptionType["BASIC"] = "BASIC";
+})(TenantLoginOptionType || (TenantLoginOptionType = {}));
+var GrantType;
+(function(GrantType) {
+	GrantType["AUTHORIZATION_CODE"] = "AUTHORIZATION_CODE";
+	GrantType["PASSWORD"] = "PASSWORD";
+})(GrantType || (GrantType = {}));
+var UserManagementSource;
+(function(UserManagementSource) {
+	UserManagementSource["REMOTE"] = "REMOTE";
+	UserManagementSource["INTERNAL"] = "INTERNAL";
+})(UserManagementSource || (UserManagementSource = {}));
+
+//#endregion
+export { GrantType, TenantLoginOptionType, UserManagementSource };