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/src/operation/OperationService.d.mts

@@ -0,0 +1,111 @@
+import { IIdentified } from "../core/IIdentified.mjs";
+import { IResultList } from "../core/IResultList.mjs";
+import { IResult } from "../core/IResult.mjs";
+import { Service } from "../core/Service.mjs";
+import { IOperation } from "./IOperation.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/OperationService.d.ts
+/**
+ * This class allows for managing operations on a device.
+ */
+declare class OperationService extends Service<IOperation> {
+  protected baseUrl: string;
+  protected listUrl: string;
+  protected propertyName: string;
+  /**
+   * Gets the details of selected operation.
+   *
+   * @param {string|number|IIdentified} entityOrId Entity or Id of the entitytabs.service.ts.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const operationId: number = 1;
+   *
+   *    (async () => {
+   *      const {data, res} = await operationService.detail(operationId);
+   *   })();
+   * ```
+   */
+  detail(entityOrId: string | number | IIdentified): Promise<IResult<IOperation>>;
+  /**
+   * Creates a new operation.
+   *
+   * @param {IOperation} entity Operation object with mandantory fragments.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const mandantoryObject: IOperation = {
+   *    com_cumulocity_model_WebCamDevice: {
+   *      name: 'take picture',
+   *      parameters: {
+   *         duration: '5s',
+   *         quality: 'HD'
+   *      }
+   *    },
+   *    deviceId: device.id,
+   *  };
+   *
+   *  (async () => {
+   *    const {data, res} = await operationService.create(mandantoryObject);
+   *  })();
+   * ```
+   */
+  create(entity: IOperation): Promise<IResult<IOperation>>;
+  /**
+   * Updates operation data.
+   *
+   * @param {Partial<IOperation>} entity Operation is partially updatable.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const partialUpdateObject: Partial<IOperation> = {
+   *    com_cumulocity_model_WebCamDevice: {
+   *      name: 'take picture',
+   *      parameters: {
+   *         duration: '2s',
+   *         quality: 'HD',
+   *         ratio: '16:9'
+   *      }
+   *    },
+   *    deviceId: device.id,
+   *  };
+   *
+   *  (async () => {
+   *    const {data, res} = await operationService.update(partialUpdateObject);
+   *  })();
+   * ```
+   */
+  update(entity: Partial<IOperation>): Promise<IResult<IOperation>>;
+  /**
+   * Gets the list of operations filtered by parameters.
+   *
+   * @returns Response wrapped in [[IResultList]]
+   *
+   * @param {object} filter Object containing filters for querying operations.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const filter: object = {
+   *     pageSize: 100,
+   *     withTotalPages: true
+   *   };
+   *
+   *   (async () => {
+   *     const {data, res, paging} = await operationService.list(filter);
+   *   })();
+   * ```
+   */
+  list(filter?: object): Promise<IResultList<IOperation>>;
+}
+//#endregion
+export { OperationService };

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

@@ -0,0 +1,12 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/OperationStatus.d.ts
+/**
+ * An Operation can have one of the following states.
+ */
+declare enum OperationStatus {
+  PENDING,
+  EXECUTING,
+  SUCCESSFUL,
+  FAILED
+}
+//#endregion
+export { OperationStatus };

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

@@ -0,0 +1,69 @@
+import { IFetchClient } from "../core/IFetchClient.mjs";
+import { Callback, CometD, HandshakeMessage, Listener, Message, SubscriptionHandle } from "cometd";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/realtime/Realtime.d.ts
+interface ICometdConfig {
+  url: string;
+  logLevel?: string;
+  requestHeaders?: any;
+  appendMessageTypeToURL?: boolean;
+  stickyReconnect?: boolean;
+}
+declare class Realtime {
+  private client;
+  private url;
+  private handshakeCallback?;
+  /**
+   * only initializing cometd if it is actually needed
+   * trying to save some memory here
+   */
+  protected get cometd(): CometD;
+  private _cometd;
+  /**
+   * Allows to set up a realtime (websocket or long-polling) connection to the platform.
+   * @param client The fetch client instance to use
+   * @param url The URL to connect to
+   * @param handshakeCallback A function which is called on succeeded or failed handshake
+   */
+  constructor(client: IFetchClient, url?: string, handshakeCallback?: (msg: HandshakeMessage) => void);
+  /**
+   * Subscribes to a realtime channel to listen for data.
+   * @param channel The channel to connect to
+   * @param callback A function to call when data is received
+   */
+  subscribe(channel: string, callback: Callback): SubscriptionHandle;
+  /**
+   * Cancels the listening to a channel.
+   * @param subscription The subscription object returned by subscribe()
+   */
+  unsubscribe(subscription: SubscriptionHandle): void;
+  /**
+   * Allows to listen to Cometd handshake to find out if e.g. the connection was reestablished.
+   */
+  addHandshakeListener(callback: (msg: HandshakeMessage) => void): SubscriptionHandle;
+  /**
+   * Allows to listen to Cometd connection to e.g. detect when connection was lost.
+   */
+  addConnectListener(callback: (msg: Message) => void): SubscriptionHandle;
+  /**
+   * Removes the subscription obtained with a call to `addHandshakeListener` or `addConnectListener`.
+   */
+  removeListener(subscriptionHandle: SubscriptionHandle): void;
+  /**
+   * Resubscribes as necessary in case of a re-handshake.
+   */
+  resubscribe(subscriptionHandle: SubscriptionHandle): SubscriptionHandle;
+  /**
+   * Disconnects the current connection.
+   */
+  disconnect(disconnectCallback?: Listener): void;
+  /**
+   * Returns true if the CometD instance is disconnected or disconnecting.
+   */
+  isDisconnected(): boolean;
+  private checkConnection;
+  private handshake;
+  private metaHandshake;
+}
+//#endregion
+export { ICometdConfig, Realtime };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/smart-groups/SmartGroupsService.d.mts

@@ -0,0 +1,126 @@
+import { IFetchClient } from "../core/IFetchClient.mjs";
+import { IResult } from "../core/IResult.mjs";
+import { Service } from "../core/Service.mjs";
+import { IManagedObject } from "../inventory/IManagedObject.mjs";
+import { IdReference } from "../inventory/InventoryService.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/smart-groups/SmartGroupsService.d.ts
+declare class SmartGroupsService extends Service<IManagedObject> {
+  protected baseUrl: string;
+  protected listUrl: string;
+  private readonly SMART_GROUP_TYPE;
+  private readonly SMART_GROUP_FRAGMENT_TYPE;
+  private readonly COLUMNS_CONFIG_FRAGMENT;
+  private readonly FILTER_CONFIG_FRAGMENT;
+  private readonly QUERY_STRING_FRAGMENT;
+  constructor(client: IFetchClient);
+  /**
+   * Gets the details of managed object
+   *
+   * @param {IdReference} entityOrId Entity or Id of the ManagedObject.
+   * @param {object} filter Filter object.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * ```typescript
+   *
+   *    const id: string = '1';
+   *    const filter: any = { withChildren: false };
+   *
+   *    (async () => {
+   *      const {data, res} = await smartGroupsService.detail(id, filter);
+   *   })();
+   * ```
+   */
+  detail(entityOrId: IdReference, filter?: object): Promise<IResult<IManagedObject>>;
+  /**
+   * Creates a smart group managed object with columns configuration.
+   *
+   * @param {object} smartGroup Dynamic group managed object.
+   * @param {object} deviceQueryString Columns configuration query string to filter the new group.
+   * @param {object} configurableColumns Configurable columns definitions.
+   * @param {object} filterConfig Columns filter configuration for the new group.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const smartGroup = { name: 'newName', type: 'c8y_DynamicGroup', c8y_IsDynamicGroup: {} };
+   *    const deviceQueryString = 'c8y_DeviceQueryString: "$filter=(name eq 'test*') $orderby=c8y_Hardware.model asc';
+   *    const configurableColumns = [
+   *        {headerName: 'Status', active: false, key: 'status'},
+   *        {headerName: 'Name', active: true, key: 'name', filter: { externalFilterQuery: { name: { names: ['test*'] } } }},
+   *        {headerName: 'Model', active: true, key: 'model'}
+   *    ];
+   *
+   *    (async () => {
+   *      await smartGroupsService.create({ smartGroup, deviceQueryString, configurableColumns });
+   *   })();
+   *
+   *    Note: filterConfig has been removed as a default property to the input object.
+   *    Now it is part of the configurable columns properties as it is shown above.
+   *    You can still pass it as an optional parameter.
+   *    ( const filterConfig = [{ name: { names: ['test*'] } }] )
+   * ```
+   */
+  create(obj: Partial<IManagedObject>): Promise<IResult<IManagedObject>>;
+  /**
+   * Updates smart group managed object with given id.
+   *
+   * @param {Partial<IManagedObject>} mo Partial managed object of the smart group.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * ```typescript
+   *
+   *    const smartGroup = { id: '1', name: 'newName' };
+   *
+   *    (async () => {
+   *      await smartGroupsService.update(smartGroup);
+   *   })();
+   * ```
+   */
+  update(mo: Partial<IManagedObject>): Promise<IResult<IManagedObject>>;
+  /**
+   * Removes managed object with given id.
+   *
+   * @param {IManagedObject} group Managed object of the group.
+   * @param {object} params Additional query params.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * ```typescript
+   *
+   *   const group = { id: '1' } as IManagedObject;
+   *   const params: any = {
+   *     withChildren: false
+   *   }
+   *
+   *    (async () => {
+   *      await smartGroupsService.delete(group, params);
+   *   })();
+   * ```
+   */
+  delete(entityOrId: IdReference, params?: any): Promise<IResult<null>>;
+  /**
+   * Checks whether a given managed object is a smart group
+   *
+   * @param {IManagedObject} mo Managed object to check.
+   *
+   * @returns boolean
+   *
+   * ```typescript
+   *
+   *    const mo: IManagedObject = {id: 1, type: "c8y_DeviceGroup", c8y_IsDeviceGroup: {}} as IManagedObject;
+   *
+   *    (() => {
+   *      const isSmartGroup = smartGroupsService.isSmartGroup(mo);
+   *   })();
+   * ```
+   */
+  isSmartGroup(mo: Partial<IManagedObject>): boolean;
+  protected getUrl(url?: string): string;
+}
+//#endregion
+export { SmartGroupsService };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/smart-rules/IRule.d.mts

@@ -0,0 +1,22 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/smart-rules/IRule.d.ts
+interface IRule {
+  id: number | string;
+  cepModuleId?: string;
+  c8y_Context?: {
+    id?: number | string;
+    context?: string;
+  };
+  name: string;
+  body?: string;
+  config?: object;
+  type?: string;
+  enabled: boolean;
+  enabledSources?: string[];
+  lastUpdated?: string;
+  ruleTemplateName: string;
+  disabledSources?: string[];
+  creationTime?: string;
+  _active?: boolean;
+}
+//#endregion
+export { IRule };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/smart-rules/SmartRulesService.d.mts

@@ -0,0 +1,90 @@
+import { IFetchClient } from "../core/IFetchClient.mjs";
+import { IResult } from "../core/IResult.mjs";
+import { Service } from "../core/Service.mjs";
+import { IdReference } from "../inventory/InventoryService.mjs";
+import { IRule } from "./IRule.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/smart-rules/SmartRulesService.d.ts
+declare class SmartRulesService extends Service<IRule> {
+  private static readonly microserviceName;
+  protected readonly baseUrl = "service/smartrule";
+  protected readonly listUrl: any;
+  private readonly rulesUrl;
+  private readonly unupdatableFields;
+  private microserviceAvailable;
+  private applicationService;
+  constructor(client: IFetchClient);
+  /**
+   * Checks if the smart rules microservice is subscribed and available to user.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    (async () => {
+   *      const isAvailable = await smartRulesService.isMicroserviceAvailable();
+   *   })();
+   * ```
+   */
+  isMicroserviceAvailable(): Promise<boolean>;
+  /**
+   * Gets a list of smart rules for given managed object.
+   *
+   * @param {IdReference} entityOrId Entity or Id of the ManagedObject.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const id: string = '1';
+   *
+   *    (async () => {
+   *      const {data, res} = await smartRulesService.listByContext(id);
+   *   })();
+   * ```
+   */
+  listByContext(entityOrId: IdReference): Promise<IResult<IRule[]>>;
+  /**
+   * Deactivates smart rule for given entities list.
+   *
+   * @param {Partial<IRule>} rule Smart rule managed object.
+   * @param {IdReference[]} entitiesOrIdsList List of entities or Id of the ManagedObjects.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const rule: IRule = {id: '1', enabledSources: ['2', '3'],...};
+   *    const entityOrIdList: IdReference[] = ['2'];
+   *    (async () => {
+   *      const {data, res} = await smartRulesService.bulkDeactivateEnabledSources(rule, entityOrIdList);
+   *   })();
+   * ```
+   */
+  bulkDeactivateEnabledSources(rule: Partial<IRule>, entitiesOrIdsList: IdReference[]): Promise<IResult<IRule>>;
+  /**
+   * Updates smart rule.
+   *
+   * @param {Parial<IRule>} rule Smart rule managed object.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const rule: IRule = {id: '1', enabledSources: ['2', '3'],...};
+   *    (async () => {
+   *      const {data, res} = await smartRulesService.updateSmartRule(rule);
+   *   })();
+   * ```
+   */
+  update(rule: Partial<IRule>): Promise<IResult<IRule>>;
+  private disableEnabledSources;
+  private getListOfStringIds;
+  private getSmartRulesUrl;
+  private removeUnclonableFields;
+  private contextRulesUrl;
+}
+//#endregion
+export { SmartRulesService };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/system-options/ISystemOption.d.mts

@@ -0,0 +1,21 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/system-options/ISystemOption.d.ts
+/**
+ * This interface holds all fragments which describes a
+ * system option object.
+ */
+interface ISystemOption {
+  /**
+   * Category of option
+   */
+  category: string;
+  /**
+   * Key of option
+   */
+  key: string;
+  /**
+   * Value of option
+   */
+  value?: string;
+}
+//#endregion
+export { ISystemOption };

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

@@ -0,0 +1,57 @@
+import { IResultList } from "../core/IResultList.mjs";
+import { IResult } from "../core/IResult.mjs";
+import { Service } from "../core/Service.mjs";
+import { ISystemOption } from "./ISystemOption.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/system-options/SystemOptionsService.d.ts
+declare class SystemOptionsService extends Service<ISystemOption> {
+  protected baseUrl: string;
+  protected listUrl: string;
+  protected propertyName: string;
+  /**
+   * 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: ISystemOption): Promise<IResult<ISystemOption>>;
+  /**
+   * 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(filter?: object): Promise<IResultList<ISystemOption>>;
+  protected getDetailUrl(option: ISystemOption): string;
+  protected onBeforeCreate(obj: ISystemOption): any;
+}
+//#endregion
+export { SystemOptionsService };

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

@@ -0,0 +1,25 @@
+import { ICustomPropertiesMap } from "../core/ICustomPropertiesMap.mjs";
+import { IApplicationReferences } from "../application/IApplicationReference.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/tenant/ICurrentTenant.d.ts
+interface ICurrentTenant extends ICustomPropertiesMap {
+  name: string;
+  domainName: string;
+  allowCreateTenants: boolean;
+  /**
+   * Containing both owned and subscribed applications
+   */
+  applications?: IApplicationReferences;
+  /**
+   * The parent tenant id
+   * Only available if current tenant has been requested with `withParent` parameter set to true.
+   */
+  parent?: string;
+  self?: string;
+}
+interface ICurrentTenantParams {
+  withParent?: boolean;
+  [key: string]: any;
+}
+//#endregion
+export { ICurrentTenant, ICurrentTenantParams };

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

@@ -0,0 +1,8 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/tenant/ISupportUser.d.ts
+interface ISupportUser {
+  expiryDate?: string;
+  enabled: boolean;
+  activeRequestCount?: number;
+}
+//#endregion
+export { ISupportUser };

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

@@ -0,0 +1,28 @@
+import { TenantStatus } from "./TenantStatus.mjs";
+import { ISupportUser } from "./ISupportUser.mjs";
+import { IApplicationReferences } from "../application/IApplicationReference.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/tenant/ITenant.d.ts
+interface ITenant {
+  id?: string;
+  domain?: string;
+  status?: TenantStatus;
+  company?: string;
+  contactName?: string;
+  contactPhone?: string;
+  applications?: IApplicationReferences;
+  ownedApplications?: IApplicationReferences;
+  adminName?: string;
+  adminPass?: string;
+  adminEmail?: string;
+  sendPasswordResetEmail?: boolean;
+  parent?: string;
+  allowCreateTenants?: boolean;
+  storageLimitPerDevice?: number;
+  creationTime?: string;
+  tenantPolicyId?: number | string;
+  customProperties?: any;
+  supportUser?: ISupportUser;
+}
+//#endregion
+export { ITenant };

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

@@ -0,0 +1,8 @@
+import { ITenant } from "./ITenant.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/tenant/ITenantReference.d.ts
+interface ITenantReference {
+  tenant: ITenant;
+}
+//#endregion
+export { ITenantReference };

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

@@ -0,0 +1,32 @@
+import { TfaStrategy } from "./TfaStrategy.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/tenant/ITfaSettings.d.ts
+interface ITfaSettings {
+  /**
+   * Two-factor authentication is enforced on system level.
+   */
+  enforcedOnSystemLevel: boolean;
+  /**
+   * Two-factor authentication is enabled on system level.
+   */
+  enabledOnSystemLevel: boolean;
+  /**
+   * Two-factor authentication is enabled on tenant level.
+   */
+  enabledOnTenantLevel: boolean;
+  /**
+   * Two-factor authentication is enforced for specific users group.
+   */
+  enforcedUsersGroup: string;
+  /**
+   * Represents a strategy used for two-factor authentication.
+   * There are two possible TFA strategies: SMS and TOTP. Only one of them can be active at a time.
+   */
+  strategy: TfaStrategy;
+  /**
+   * TOTP is enforced on tenant level.
+   */
+  totpEnforcedOnTenantLevel: boolean;
+}
+//#endregion
+export { ITfaSettings };