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/tenant-login-options/TenantLoginOptionsService.mjs

@@ -0,0 +1,217 @@
+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-login-options/TenantLoginOptionsService.js
+/**
+* @description
+* This service allows to get tenant login options.
+*/
+var TenantLoginOptionsService = class extends Service {
+	constructor() {
+		super(...arguments);
+		this.baseUrl = "tenant";
+		this.listUrl = "loginOptions";
+		this.propertyName = "loginOptions";
+	}
+	/**
+	* Gets the details of login option.
+	*
+	* @param entityIdentityOrId Login option's id or login option object.
+	*
+	* @returns Returns promise object that is resolved with the ITenantLoginOption wrapped by IResult.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const tenantLoginOptionId: string = 'uniqueTenantLoginOptionId';
+	*
+	*    (async () => {
+	*      const {data, res} = await tenantLoginOptionsService.detail(tenantLoginOptionId);
+	*   })();
+	* ```
+	*/
+	detail(entityIdentityOrId) {
+		const _super = Object.create(null, { detail: { get: () => super.detail } });
+		return __awaiter(this, void 0, void 0, function* () {
+			return _super.detail.call(this, entityIdentityOrId);
+		});
+	}
+	/**
+	* Gets the list of tenant's login options filtered by parameters.
+	*
+	* @param filter Object containing filters for querying tenant's login options.
+	*
+	* @returns Returns promise object that is resolved with the ITenantLoginOption wrapped by IResultList.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const filter: object = {
+	*     tenantId: '1111111'
+	*   };
+	*
+	*   (async () => {
+	*     const {data, res, paging} = await tenantLoginOptionsService.list(filter);
+	*   })();
+	* ```
+	*/
+	list() {
+		const _super = Object.create(null, { list: { get: () => super.list } });
+		return __awaiter(this, arguments, void 0, function* (filter = {}) {
+			return _super.list.call(this, filter);
+		});
+	}
+	/**
+	* Gets the list of all tenant's login options for current tenant.
+	*
+	* @returns Returns promise object that is resolved with the ITenantLoginOption wrapped by IResultList.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*   (async () => {
+	*     const {data, res, paging} = await tenantLoginOptionsService.listForCurrentTenant();
+	*   })();
+	* ```
+	*/
+	listForCurrentTenant() {
+		const _super = Object.create(null, { list: { get: () => super.list } });
+		return __awaiter(this, void 0, void 0, function* () {
+			return _super.list.call(this, { tenantId: this.client.tenant });
+		});
+	}
+	/**
+	* Gets the list of all tenant's login options for management tenant.
+	*
+	* @returns Returns promise object that is resolved with the ITenantLoginOption wrapped by IResultList.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*   (async () => {
+	*     const {data, res, paging} = await tenantLoginOptionsService.listForManagement();
+	*   })();
+	* ```
+	*/
+	listForManagement() {
+		const _super = Object.create(null, { list: { get: () => super.list } });
+		return __awaiter(this, void 0, void 0, function* () {
+			return _super.list.call(this, { management: true });
+		});
+	}
+	/**
+	* Creates a new tenant login option.
+	*
+	* @param entity ITenantLoginOption object.
+	*
+	* @returns Returns promise object that is resolved with the details of newly created tenant login option.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const tenantLoginOption: ITenantLoginOption = {
+	*    grantType: "PASSWORD",
+	*    providerName: "Cumulocity",
+	*    type: "BASIC",
+	*    userManagementSource: "INTERNAL",
+	*    visibleOnLoginPage: true
+	*  };
+	*
+	*  (async () => {
+	*    const {data, res} = await tenantLoginOptionsService.create(tenantLoginOption);
+	*  })();
+	* ```
+	*/
+	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's login option data.
+	*
+	* @param entity ITenantLoginOption object.
+	*
+	* @returns Returns promise object that is resolved with the saved tenant's login option object.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const tenantLoginOption: ITenantLoginOption = {
+	*    grantType: "PASSWORD",
+	*    id: "2eff9a0b-e376-4ce8-a0f1-0a07cef8a8a1",
+	*    providerName: "Cumulocity",
+	*    type: "BASIC",
+	*    userManagementSource: "INTERNAL",
+	*    visibleOnLoginPage: true
+	*  };
+	*
+	*  (async () => {
+	*    const {data, res} = await tenantLoginOptionsService.update(tenantLoginOption);
+	*  })();
+	* ```
+	*/
+	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);
+		});
+	}
+	/**
+	* Update tenant's login option data if id exists in object, otherwise create new entity.
+	*
+	* @param entity ITenantLoginOption object.
+	*
+	* @returns Returns promise object that is resolved with the saved tenant's login option object.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const tenantLoginOption: ITenantLoginOption = {
+	*    grantType: "PASSWORD",
+	*    id: "2eff9a0b-e376-4ce8-a0f1-0a07cef8a8a1",
+	*    providerName: "Cumulocity",
+	*    type: "BASIC",
+	*    userManagementSource: "INTERNAL",
+	*    visibleOnLoginPage: true
+	*  };
+	*
+	*  (async () => {
+	*    const {data, res} = await tenantLoginOptionsService.save(tenantLoginOption);
+	*  })();
+	* ```
+	*/
+	save(entity) {
+		return __awaiter(this, void 0, void 0, function* () {
+			return entity.id ? this.update(entity) : this.create(entity);
+		});
+	}
+	/**
+	* Removes tenant's login option.
+	*
+	* @param entityOrId Tenant's login option's id or tenant's login option object.
+	*
+	* @returns Returns promise object that is resolved with the IResult of null.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const tenantLoginOptionId: string = 'uniqueTenantLoginOptionId';
+	*
+	*    (async () => {
+	*      const {data, res} = await tenantLoginOptionsService.delete(tenantLoginOptionId);
+	*   })();
+	* ```
+	*/
+	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);
+		});
+	}
+};
+
+//#endregion
+export { TenantLoginOptionsService };

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

@@ -0,0 +1,4 @@
+import { TenantLoginOptionsService } from "./TenantLoginOptionsService.mjs";
+import { GrantType, TenantLoginOptionType, UserManagementSource } from "./ITenantLoginOptions.mjs";
+
+export {  };

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

@@ -0,0 +1,183 @@
+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-options/TenantOptionsService.js
+/**
+* @description
+* This service allows for managing tenant's options.
+*/
+var TenantOptionsService = class extends Service {
+	constructor() {
+		super(...arguments);
+		this.baseUrl = "tenant";
+		this.listUrl = "options";
+		this.propertyName = "options";
+		this.securityOptionsCategories = ["password"];
+		this.securityOptionsListUrl = "security-options";
+		this.systemOptions = "system";
+	}
+	/**
+	* Get a representation of a tenant's option.
+	*
+	* @param entity Tenant option object.
+	* @param params Additional query parameters.
+	*
+	* @returns Returns promise object that is resolved with
+	* the ITenantOption wrapped by IResult.
+	*
+	* **Example**
+	* ```typescript
+	* const option: ITenantOption = {
+	*   category: 'access.control',
+	*   key: 'allow.origin'
+	* };
+	* const params: ITenantOptionDetailParams = {
+	*   evaluate: 'inherited'
+	* };
+	* (async () => {
+	*   const { data, res } = await tenantService.detail(option);
+	*   console.log('value inherited from parent tenant:', data.value);
+	* })();
+	* ```
+	*
+	* Required role: ROLE_OPTION_MANAGEMENT_READ
+	*/
+	detail(entity_1) {
+		const _super = Object.create(null, { detail: { get: () => super.detail } });
+		return __awaiter(this, arguments, void 0, function* (entity, params = {}) {
+			return _super.detail.call(this, entity, params);
+		});
+	}
+	/**
+	* Creates a new tenant's option.
+	*
+	* @param {ITenantOption} entity Tenant's Option object.
+	*
+	* @returns {IResult<IIdentified>} Returns promise object that is resolved with
+	* the details of newly created tenant option.
+	*
+	* **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_OPTION_MANAGEMENT_ADMIN<br><br>
+	* Options are category-key-value tuples, storing tenant configuration.Some categories of options
+	* allow creation of new one, other are limited to predefined set of keys.<br><br>
+	* Any option of any tenant can be defined as "non-editable" by "management" tenant. Afterwards, any PUT or DELETE
+	* requests made on that option by the owner tenant, will result in 403 error (Unauthorized).
+	*/
+	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's option data.
+	*
+	* @param {ITenantOption} entity Tenant option is partially updatable.
+	*
+	* @returns {IResult<ITenantOption>} Returns promise object that is resolved with the saved tenant option object.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const partialUpdateObject: IIdentified = {
+	*     value : "http://developer.cumulocity.com"
+	*     ...
+	*   }
+	*
+	*  (async () => {
+	*    const {data, res} = await tenantOptionsService.update(partialUpdateObject);
+	*  })();
+	* ```
+	*
+	* Required role: ROLE_OPTION_MANAGEMENT_ADMIN
+	*/
+	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 tenant's options filtered by parameters.
+	*
+	* @param {object} filter Object containing filters for querying tenant options.
+	*
+	* @returns {IResultList<ITenantOption>} Returns promise object that is resolved
+	* with the ITenantOption wrapped by IResultList.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const filter: object = {
+	*     severity: Severity.MAJOR,
+	*     pageSize: 100,
+	*     withTotalPages: true
+	*   };
+	*
+	*   (async () => {
+	*     const {data, res, paging} = await tenantOptionsService.list(filter);
+	*   })();
+	* ```
+	*
+	* Required role: ROLE_OPTION_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's option.
+	*
+	* @param {string|number|IIdentified} entityOrId Tenant's option id or tenant's option object.
+	*
+	* @returns Returns promise object that is resolved with the IResult.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const tenantOptionId: string = "uniqueTenantId";
+	*
+	*    (async () => {
+	*      const {data, res} = await tenantOptionsService.delete(tenantOptionId);
+	*   })();
+	* ```
+	*
+	* 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);
+		});
+	}
+	getDetailUrl(entity) {
+		const encodedCategory = encodeURIComponent(entity.category);
+		const encodedKey = encodeURIComponent(entity.key);
+		if (this.securityOptionsCategories.indexOf(entity.category) > -1) return `${this.securityOptionsListUrl}/${encodedCategory}/${encodedKey}`;
+		else return `${this.listUrl}/${encodedCategory}/${encodedKey}`;
+	}
+	onBeforeCreate(obj) {
+		return obj;
+	}
+};
+
+//#endregion
+export { TenantOptionsService };

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

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

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

@@ -0,0 +1,52 @@
+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-security-options/TenantSecurityOptionsService.js
+/**
+* @description
+* This service allows to get tenant security option.
+*/
+var TenantSecurityOptionsService = class extends Service {
+	constructor() {
+		super(...arguments);
+		this.baseUrl = "tenant";
+		this.listUrl = "security-options";
+		this.category = "password";
+		this.propertyName = "options";
+	}
+	/**
+	* Get a specific tenant's security option.
+	*
+	* @param {ITenantSecurityOption} Tenant's security option object with key value.
+	*
+	* @returns Returns promise object that is resolved with the ITenantSecurityOption wrapped by IResult.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*     const option: ITenantSecurityOption = {
+	*        key: 'limit.validity'
+	*      };
+	*
+	*    (async () => {
+	*      const {data, res} = await tenantSecurityOptionsService.detail(option);
+	*   })();
+	* ```
+	*/
+	detail(tenantSecurityOption) {
+		const _super = Object.create(null, { detail: { get: () => super.detail } });
+		return __awaiter(this, void 0, void 0, function* () {
+			return _super.detail.call(this, tenantSecurityOption);
+		});
+	}
+	getDetailUrl(tenantSecurityOption) {
+		return `${this.listUrl}/${this.category}/${tenantSecurityOption.key}`;
+	}
+	onBeforeCreate(obj) {
+		return obj;
+	}
+};
+
+//#endregion
+export { TenantSecurityOptionsService };

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

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

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/trusted-certificates/CrlService.mjs

@@ -0,0 +1,112 @@
+import { __toESM } from "../../../../../../../../../../_virtual/rolldown_runtime.mjs";
+import { __awaiter } from "../../../../../../../../tslib@2.8.1/node_modules/tslib/tslib.es6.mjs";
+import { Service } from "../core/Service.mjs";
+import "../core/index.mjs";
+import { require_form_data } from "../../../../../../../../form-data@4.0.4/node_modules/form-data/lib/form_data.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/trusted-certificates/CrlService.js
+var import_form_data = /* @__PURE__ */ __toESM(require_form_data());
+/**
+* This class allows for managing a list of certificate revocations.
+*/
+var CrlService = class extends Service {
+	get baseUrl() {
+		return `/tenant/trusted-certificates/settings/crl`;
+	}
+	/**
+	* Uploads a list of certificate revocations.
+	* Adds new entries to the certificate revocation list,
+	* the ones that already exist are updated.
+	* No entries are removed from the certificate revocation list.
+	*
+	* @returns Returns a status object.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const crls: ICertificateRevocation[] = [
+	*      { serialNumberInHex: '24234', revocationDate: '2023-01-13T23:00:00.000Z' }
+	*    ];
+	*
+	*   (async () => {
+	*     const { res } = await crlService.uploadCrls(crls);
+	*   })();
+	* ```
+	*/
+	uploadCrls(crls) {
+		return __awaiter(this, void 0, void 0, function* () {
+			const method = "PUT";
+			const headers = {
+				"content-type": "application/json",
+				Accept: "application/json"
+			};
+			const body = JSON.stringify({ crls });
+			return {
+				res: yield this.fetch("", {
+					method,
+					body,
+					headers
+				}),
+				data: null
+			};
+		});
+	}
+	/**
+	* Uploads a csv file containing a list of certificate revocations.
+	* Adds new entries to the certificate revocation list,
+	* the ones that already exist are updated.
+	* No entries are removed from the certificate revocation list.
+	*
+	* File format:
+	* SERIALNO,DATE
+	* 1234567890abcdef,2023-01-01T00:00:00.000Z
+	*
+	* @returns Returns a status object.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*   (async () => {
+	*     const { res } = await crlService.uploadCrlFile( file );
+	*   })();
+	* ```
+	*/
+	uploadCrlFile(file) {
+		return __awaiter(this, void 0, void 0, function* () {
+			const method = "PUT";
+			const body = new import_form_data.default();
+			body.append("file", file);
+			return {
+				res: yield this.fetch("", {
+					method,
+					body,
+					headers: { accept: "application/json" }
+				}),
+				data: null
+			};
+		});
+	}
+	/**
+	* Downloads a certificate revocation list file.
+	* To open the downloaded file please use command: openssl crl -inform DER -text -noout -in fileName.crl
+	*
+	* @returns Returns a arrayBuffer wrapped in [[IFetchResponse]].
+	*
+	* **Example**
+	* ```typescript
+	*
+	*   (async () => {
+	*     const res = await this.crlService.downloadCrlFile();
+	*     const arrayBuffer = await res.arrayBuffer();
+	*   })();
+	* ```
+	*/
+	downloadCrlFile(init) {
+		return __awaiter(this, void 0, void 0, function* () {
+			return yield this.fetch("", init);
+		});
+	}
+};
+
+//#endregion
+export { CrlService };