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/user/index.mjs

@@ -0,0 +1,5 @@
+import { UserInventoryRoleService } from "./UserInventoryRoleService.mjs";
+import { UserService } from "./UserService.mjs";
+import { PasswordStrength } from "./PasswordStrength.mjs";
+
+export {  };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/user-group/UserGroupService.mjs

@@ -0,0 +1,306 @@
+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/user-group/UserGroupService.js
+var ChildType;
+(function(ChildType) {
+	ChildType["ROLES"] = "roles";
+	ChildType["USERS"] = "users";
+})(ChildType || (ChildType = {}));
+/**
+* @description
+* This service allows for managing user groups.
+*/
+var UserGroupService = class extends Service {
+	constructor() {
+		super(...arguments);
+		this.baseUrl = "user";
+		this.propertyName = "groups";
+	}
+	get listUrl() {
+		return `${this.client.tenant}/groups`;
+	}
+	/**
+	* Gets the details of given user group.
+	*
+	* @param {string|number|IUserGroup} entityOrId Group's id or role object.
+	*
+	* @returns Returns promise object that is resolved with the IUserGroup wrapped by IResult.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const groupId: number = 1;
+	*
+	*    (async () => {
+	*      const {data, res} = await userGroupService.detail(roleId);
+	*   })();
+	* ```
+	*/
+	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 user group.
+	*
+	* @param {IUserGroup} entity User Group object.
+	*
+	* @returns {IResult<IUserGroup>} Returns promise object that is resolved with
+	* the details of newly created user group.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const userGroupObject: IUserGroup = {
+	*    name: "new user group"
+	*  };
+	*
+	*  (async () => {
+	*    const {data, res} = await userGroupService.create(userGroupObject);
+	*  })();
+	* ```
+	*/
+	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 user group data.
+	*
+	* @param {Partial<IUserGroup>} entity User group is partially updatable.
+	*
+	* @returns {IResult<IUserGroup>} Returns promise object that is resolved with the saved user group object.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const partialUpdateObject: Partial<IUserGroup> = {
+	*     "id" : 1,
+	*     "self" : "[URL to this resource]",
+	*     "name" : "PlatformAdministrators",
+	*     ...
+	*   }
+	*
+	*  (async () => {
+	*    const {data, res} = await userGroupService.update(partialUpdateObject);
+	*  })();
+	* ```
+	*/
+	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 user groups filtered by parameters.
+	*
+	* @param {object} filter Object containing filters for querying User Groups.
+	*
+	* @returns Returns promise object that is resolved with the IUserGroup wrapped by IResultList.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const filter: object = {
+	*     severity: Severity.MAJOR,
+	*     pageSize: 100,
+	*     withTotalPages: true
+	*   };
+	*
+	*   (async () => {
+	*     const {data, res, paging} = await userGroupService.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);
+		});
+	}
+	/**
+	* Removes user group.
+	*
+	* @param {number | IIdentified} entityOrId User group's id or user group object.
+	*
+	* @returns Returns promise object that is resolved with the IResult of null.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const userGroupId: number = 1;
+	*
+	*    (async () => {
+	*      const {data, res} = await userGroupService.delete(userGroupId);
+	*   })();
+	* ```
+	* When group is removed, suitable audit records are created with type 'User'
+	* and activity 'User updated' with information that user has been removed from group.
+	*
+	* Please, note that the ADMINS and DEVICES groups can not be deleted.
+	*/
+	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);
+		});
+	}
+	/**
+	* Assign role to user group.
+	*
+	* @param {string | number | Partial<IUserGroup>} entityOrId User group's id or user group object.
+	* @param {string | Partial<ISource>} childEntityOrSelf Url to role resource or IRoleReference object.
+	*
+	* @returns Returns promise object that is resolved with the IRoleReference wrapped by IResult.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const userGroupId: number = 1;
+	*    const roleResource: string = "[URL to the Role resource]";
+	*
+	*    (async () => {
+	*      const {data, res} = await userGroupService.addRoleToGroup(userGroupId, roleResource);
+	*   })();
+	* ```
+	* When role is assigned to user, suitable audit record is created with type 'User' and activity 'User updated'.
+	*/
+	addRoleToGroup(entityOrId, childEntityOrSelf) {
+		return __awaiter(this, void 0, void 0, function* () {
+			return this.addChild(ChildType.ROLES, entityOrId, childEntityOrSelf);
+		});
+	}
+	/**
+	* Unassign role from user
+	*
+	* @param {string | number | Partial<IUserGroup>} entityOrId User group's id or user group object.
+	* @param {string | Partial<ISource>} childEntityOrSelf Url to user resource or IRoleReference object.
+	*
+	* @returns Returns promise object that is resolved with the IResult of null.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const userGroupId: number = 1;
+	*    const userResource: string = "[URL to the Role resource]";
+	*
+	*    (async () => {
+	*      const {data, res} = await userGroupService.removeRoleFromGroup(userGroupId, userResource);
+	*   })();
+	* ```
+	*/
+	removeRoleFromGroup(entityOrId, childEntityOrSelf) {
+		return __awaiter(this, void 0, void 0, function* () {
+			return this.removeChild(ChildType.ROLES, entityOrId, childEntityOrSelf);
+		});
+	}
+	/**
+	* Assign user to user group.
+	*
+	* @param {string | number | Partial<IUserGroup>} entityOrId User group's id or user group object.
+	* @param {string | Partial<ISource>} childEntityOrSelf Url to user resource or IUserReference object.
+	*
+	* @returns Returns promise object that is resolved with the IUserReference wrapped by IResult.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const userGroupId: number = 1;
+	*    const userResource: string = "[URL to the User resource]";
+	*
+	*    (async () => {
+	*      const {data, res} = await userGroupService.addUserToGroup(userGroupId, userResource);
+	*   })();
+	* ```
+	* When user is added to group, suitable audit record is created with type 'User' and activity 'User updated'.
+	*/
+	addUserToGroup(entityOrId, childEntityOrSelf) {
+		return __awaiter(this, void 0, void 0, function* () {
+			return this.addChild(ChildType.USERS, entityOrId, childEntityOrSelf);
+		});
+	}
+	/**
+	* Remove user from a group
+	*
+	* @param {string | number | Partial<IUserGroup>} entityOrId User group's id or user group object.
+	* @param {string | Partial<ISource>} childEntityOrSelf Url to user resource or IUserReference object.
+	*
+	* @returns Returns promise object that is resolved with the IResult of null.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const userGroupId: number = 1;
+	*    const userResource: string = "[URL to the User resource]";
+	*
+	*    (async () => {
+	*      const {data, res} = await userGroupService.removeUserFromGroup(userGroupId, userResource);
+	*   })();
+	* ```
+	* When user is removed from group, suitable audit record is created with type 'User' and activity 'User updated'.
+	*/
+	removeUserFromGroup(entityOrId, childEntityOrSelf) {
+		return __awaiter(this, void 0, void 0, function* () {
+			return this.removeChild(ChildType.USERS, entityOrId, childEntityOrSelf);
+		});
+	}
+	getSelf(childReference) {
+		if (typeof childReference === "object" && childReference.self) return childReference.self;
+		else return childReference;
+	}
+	getChildUrl(type, userGroupOrId) {
+		return `${this.getDetailUrl(userGroupOrId)}/${type}`;
+	}
+	getChildReferenceAsBody(type, childReference) {
+		const childSelf = this.getSelf(childReference);
+		switch (type) {
+			case ChildType.ROLES: return JSON.stringify({ role: { self: String(childSelf) } });
+			case ChildType.USERS: return JSON.stringify({ user: { self: String(childSelf) } });
+		}
+		throw new Error("UserGroupService -> getChild -> unsupported child type");
+	}
+	addChild(type, userGroupOrId, childReference) {
+		return __awaiter(this, void 0, void 0, function* () {
+			const url = this.getChildUrl(type, userGroupOrId);
+			const method = "POST";
+			const body = this.getChildReferenceAsBody(type, childReference);
+			const res = yield this.fetch(url, {
+				method,
+				body,
+				headers: {
+					accept: "application/json",
+					"content-type": "application/json"
+				}
+			});
+			let data = yield res.json();
+			data = data.managedObject;
+			return {
+				res,
+				data
+			};
+		});
+	}
+	removeChild(type, userGroupOrId, childReference) {
+		return __awaiter(this, void 0, void 0, function* () {
+			const childId = this.getIdString(childReference);
+			const url = `${this.getChildUrl(type, userGroupOrId)}/${encodeURIComponent(String(childId))}`;
+			return {
+				res: yield this.fetch(url, {
+					method: "DELETE",
+					headers: { accept: "application/json" }
+				}),
+				data: null
+			};
+		});
+	}
+};
+
+//#endregion
+export { UserGroupService };

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

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

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/esm2015/src/user-role/UserRoleService.mjs

@@ -0,0 +1,70 @@
+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/user-role/UserRoleService.js
+/**
+* @description
+* This service allows for fetch user roles.
+*/
+var UserRoleService = class extends Service {
+	constructor() {
+		super(...arguments);
+		this.baseUrl = "user";
+		this.listUrl = "roles";
+		this.propertyName = "roles";
+	}
+	/**
+	* Gets the details of given role.
+	*
+	* @param {string|number|IRole} entityOrId Roles's id or role object.
+	*
+	* @returns Returns promise object that is resolved with the IRole wrapped by IResult.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*    const roleId: number = 1;
+	*
+	*    (async () => {
+	*      const {data, res} = await userRoleService.detail(roleId);
+	*   })();
+	* ```
+	*/
+	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);
+		});
+	}
+	/**
+	* Gets the list of user roles filtered by parameters.
+	*
+	* @param {object} filter Object containing filters for querying roles.
+	*
+	* @returns Returns promise object that is resolved with the IRole wrapped by IResultList.
+	*
+	* **Example**
+	* ```typescript
+	*
+	*  const filter: object = {
+	*     severity: Severity.MAJOR,
+	*     pageSize: 100,
+	*     withTotalPages: true
+	*   };
+	*
+	*   (async () => {
+	*     const {data, res, paging} = await userRoleService.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);
+		});
+	}
+};
+
+//#endregion
+export { UserRoleService };

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

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

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/Client.d.mts

@@ -0,0 +1,218 @@
+import { IFetchOptions } from "./core/IFetchOptions.mjs";
+import { IFetchResponse } from "./core/IFetchResponse.mjs";
+import { Realtime } from "./realtime/Realtime.mjs";
+import { IAuthentication, ICredentials } from "./core/IAuthentication.mjs";
+import { FetchClient } from "./core/FetchClient.mjs";
+import { EventService } from "./event/EventService.mjs";
+import { InventoryBinaryService } from "./inventory/InventoryBinaryService.mjs";
+import { InventoryService } from "./inventory/InventoryService.mjs";
+import { MeasurementService } from "./measurement/MeasurementService.mjs";
+import { AlarmService } from "./alarm/AlarmService.mjs";
+import { OperationService } from "./operation/OperationService.mjs";
+import { OperationBulkService } from "./operation/OperationBulkService.mjs";
+import { TenantService } from "./tenant/TenantService.mjs";
+import { UserRoleService } from "./user-role/UserRoleService.mjs";
+import { UserGroupService } from "./user-group/UserGroupService.mjs";
+import { UserService } from "./user/UserService.mjs";
+import { ApplicationService } from "./application/ApplicationService.mjs";
+import { SystemOptionsService } from "./system-options/SystemOptionsService.mjs";
+import { TenantOptionsService } from "./tenant-options/TenantOptionsService.mjs";
+import { TenantSecurityOptionsService } from "./tenant-security-options/TenantSecurityOptionsService.mjs";
+import { TenantLoginOptionsService } from "./tenant-login-options/TenantLoginOptionsService.mjs";
+import { AuditService } from "./audit/AuditService.mjs";
+import { InventoryRoleService } from "./inventory-role/InventoryRoleService.mjs";
+import { DeviceRegistrationService } from "./device-registration/DeviceRegistrationService.mjs";
+import { DeviceRegistrationBulkService } from "./device-registration/DeviceRegistrationBulkService.mjs";
+import { IdentityService } from "./identity/IdentityService.mjs";
+import { SmartGroupsService } from "./smart-groups/SmartGroupsService.mjs";
+import { SmartRulesService } from "./smart-rules/SmartRulesService.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/Client.d.ts
+interface IBootstrapOptions {
+  deviceId: string;
+  basicAuthToken: string;
+  timeout?: number;
+  expire?: number;
+  baseUrl?: string;
+}
+declare class Client {
+  /**
+   * Authenticates the given user. Determines the tenant by itself via a call to tenant/currentTenant.
+   *
+   * **Example**
+   * ```typescript
+   *
+   * let client: Client;
+   * (async () => {
+   *  client = await Client.authenticate({
+   *    user: 'testuser',
+   *    password: 'password1337!'
+   *  }, 'https://acme.cumulocity.com');
+   *
+   *  //you have access to the client api now
+   *  const { data, paging, res }); =  await client.inventory.list({ pageSize: 100 });
+   * })();
+   * ```
+   */
+  static authenticate(credentials: ICredentials, baseUrl?: string): Promise<Client>;
+  /**
+   * Authenticates the given user via OAuth Internal. Determines the tenant by itself via a call to tenant/currentTenant.
+   * Login call goes to `/tenant/oauth/token` and the retrieved token will be added in the `Authorization` header to subsequent requests.
+   *
+   * **Example**
+   * ```typescript
+   *
+   * let client: Client;
+   * (async () => {
+   *  client = await Client.authenticateViaOAuthInternal({
+   *    user: 'testuser',
+   *    password: 'password1337!'
+   *  }, 'https://acme.cumulocity.com');
+   *
+   *  //you have access to the client api now
+   *  const { data, paging, res }); =  await client.inventory.list({ pageSize: 100 });
+   * })();
+   * ```
+   */
+  static authenticateViaOAuthInternal(credentials: ICredentials, baseUrl?: string): Promise<Client>;
+  /**
+   * Authenticates the given user via OAuth Internal. Determines the tenant by itself via a call to tenant/currentTenant.
+   * Login call goes to `/tenant/oauth` and the retrieved token will be attached as a Cookie in browser environments to subsequent requests (using 'CookieAuth').
+   * In none browser environments (e.g. nodejs) the retrieved token will be added in the `Authorization` header to subsequent requests (using 'NodeJSCookieAuth').
+   *
+   * **Example**
+   * ```typescript
+   *
+   * let client: Client;
+   * (async () => {
+   *  client = await Client.authenticateViaOAuthInternalCookie({
+   *    user: 'testuser',
+   *    password: 'password1337!'
+   *  }, 'https://acme.cumulocity.com');
+   *
+   *  //you have access to the client api now
+   *  const { data, paging, res }); =  await client.inventory.list({ pageSize: 100 });
+   * })();
+   * ```
+   */
+  static authenticateViaOAuthInternalCookie(credentials: ICredentials, baseUrl?: string): Promise<Client>;
+  /**
+   * Allows to use http to register a device on the platform.
+   *
+   * **Deprecated** Please use MQTT to bootstrap a device.
+   */
+  static deviceBootstrap(options: IBootstrapOptions): Promise<Client>;
+  /**
+   * Retrieves microservice credentials for the subscribed tenants
+   * using provided bootstrap credentials
+   *
+   * **Example**
+   * ```typescript
+   *
+   * (async () => {
+   *  const subscriptions = await Client.getMicroserviceSubscriptions({
+   *    tenant: process.env.C8Y_BOOTSTRAP_TENANT,
+   *    user: process.env.C8Y_BOOTSTRAP_USER,
+   *    password: process.env.C8Y_BOOTSTRAP_PASSWORD
+   *  }, process.env.C8Y_BASEURL);
+   *
+   *  const clients = subscriptions.map(subscription => new Client(new BasicAuth(subscription), process.env.C8Y_BASEURL));
+   *  // you have access to the client api now
+   *  const promiseArray = clients.map(client => client.options.tenant.detail({
+   *    category: process.env.APPLICATION_KEY,
+   *    key: 'someSetting'
+   *  }));
+   * })();
+   * ```
+   */
+  static getMicroserviceSubscriptions(bootstrapCredentials: ICredentials, baseUrl?: string, fetchOptions?: IFetchOptions): Promise<ICredentials[]>;
+  /**
+   * Performs the OAuth Internal login.
+   *
+   * If the parameter `bearerAuth` is set to true (default), the `/tenant/oauth/token` endpoint is called and a string containing the token returned.
+   *
+   * If the parameter `bearerAuth` is set to false, the `/tenant/oauth` endpoint is called and a Cookie should be set and the response returned.
+   * The response can be used in none browser environments to extract the `set-cookie` header from it.
+   *
+   * **Example**
+   * ```typescript
+   *
+   * (async () => {
+   *  const client = await Client.loginViaOAuthInternal({
+   *    tenant: process.env.C8Y_BOOTSTRAP_TENANT,
+   *    user: process.env.C8Y_BOOTSTRAP_USER,
+   *    password: process.env.C8Y_BOOTSTRAP_PASSWORD
+   *  }, true, process.env.C8Y_BASEURL);
+   *
+   *  // you have access to the client api now
+   *  const option = client.options.tenant.detail({
+   *    category: process.env.APPLICATION_KEY,
+   *    key: 'someSetting'
+   *  });
+   * })();
+   * ```
+   */
+  static loginViaOAuthInternal(credentials: ICredentials, bearerAuth?: true, baseUrl?: string): Promise<string>;
+  static loginViaOAuthInternal(credentials: ICredentials, bearerAuth: false, baseUrl?: string): Promise<IFetchResponse>;
+  private static getCurrentTenant;
+  alarm: AlarmService;
+  application: ApplicationService;
+  audit: AuditService;
+  core: FetchClient;
+  deviceRegistration: DeviceRegistrationService;
+  deviceRegistrationBulk: DeviceRegistrationBulkService;
+  event: EventService;
+  inventory: InventoryService;
+  inventoryRole: InventoryRoleService;
+  inventoryBinary: InventoryBinaryService;
+  measurement: MeasurementService;
+  operation: OperationService;
+  operationBulk: OperationBulkService;
+  options: {
+    security: TenantSecurityOptionsService;
+    system: SystemOptionsService;
+    login: TenantLoginOptionsService;
+    tenant: TenantOptionsService;
+  };
+  realtime: Realtime;
+  role: InventoryRoleService;
+  tenant: TenantService;
+  user: UserService;
+  userGroup: UserGroupService;
+  userRole: UserRoleService;
+  identity: IdentityService;
+  smartGroups: SmartGroupsService;
+  smartRules: SmartRulesService;
+  /**
+   * Initializes a new Client, which allows to request data from the API. Differently
+   * to Client.authenticate([...]) it needs a tenant given and does not verify if the
+   * login is correct.
+   *
+   * **Example**
+   * ```typescript
+   *
+   * const auth = new BasicAuth({
+   *   user: 'youruser',
+   *   password: 'yourpassword',
+   *   tenant: 'acme'
+   * }); // use CookieAuth() if your platform uses oauth (only in browser!)
+   *
+   * const baseUrl = 'https://acme.cumulocity.com';
+   * const client = new Client(auth, baseUrl);
+   * (async () => {
+   *   const { data, paging, res }); =  await client.inventory.list({ pageSize: 100 });
+   * })();
+   * ```
+   *
+   * @param auth The Authentication strategy to use (e.g. new BasicAuth())
+   * @param baseUrl The URL to request (optional in browser, mandatory in node)
+   */
+  constructor(auth: IAuthentication, baseUrl?: string);
+  /**
+   * Allows to change the current Authentication
+   * @param auth The new Authentication information.
+   */
+  setAuth(auth: IAuthentication): void;
+}
+//#endregion
+export { Client, IBootstrapOptions };