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/device-registration/DeviceRegistrationService.d.mts

@@ -0,0 +1,296 @@
+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 { IDeviceRegistration, IDeviceRegistrationAccept, IDeviceRegistrationCreate, IDeviceRegistrationLimit } from "./IDeviceRegistration.mjs";
+import { IDeviceCredentials } from "./IDeviceCredentials.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/device-registration/DeviceRegistrationService.d.ts
+/**
+ * Interface to use as options parameter
+ * to bootstrap a new device.
+ */
+interface IDeviceBootstrapOptions {
+  /**
+   * If already logged in it is accessible via
+   * client.auth.getFetchOptions, see [[BasicAuth.getFetchOptions]]
+   *
+   * **Example**
+   * ``` typescript
+   *
+   * // tenant/username:password
+   * const basicAuthToken = 'Basic dGVuYW50L3VzZXJuYW1lOnBhc3N3b3Jk';
+   * ```
+   */
+  basicAuthToken?: string;
+  /**
+   * Object to define username and password
+   * as string.
+   *
+   * **Example**
+   * ``` typescript
+   *
+   *    const basicAuth = {
+   *      user: 'username',
+   *      pass: 'password'
+   *    }
+   * ```
+   */
+  basicAuth?: {
+    user: string;
+    pass: string;
+  };
+}
+/**
+ * This class allows registration of a new device.
+ */
+declare class DeviceRegistrationService extends Service<IDeviceRegistration> {
+  protected baseUrl: string;
+  protected listUrl: string;
+  protected propertyName: string;
+  /**
+   * Gets the details of device registration.
+   *
+   * @param {string|number|IIdentified} entityOrId Entity or Id of the entity.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const entityId: number = 1;
+   *
+   *    (async () => {
+   *      const {data, res} = await deviceRegistrationService.detail(entityId);
+   *    })();
+   * ```
+   */
+  detail(entityOrId: string | number | IIdentified): Promise<IResult<IDeviceRegistration>>;
+  /**
+   * Creates a new device registration.
+   *
+   * @param {IDeviceRegistrationCreate} entity Device registration object with mandantory fragments.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const mandantoryObject: IDeviceRegistrationCreate = {
+   *      id: 1,
+   *    };
+   *
+   *    (async () => {
+   *      const {data, res} = await deviceRegistrationService.create(mandantoryObject);
+   *    })();
+   * ```
+   */
+  create(entity: IDeviceRegistrationCreate): Promise<IResult<IDeviceRegistration>>;
+  /**
+   * Gets the list of device registrations by parameters.
+   *
+   * @returns Response wrapped in [[IResultList]]
+   *
+   * @param {object} filter Object containing filters for querying registrations.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   const filter: object = {
+   *     pageSize: 100,
+   *     withTotalPages: true
+   *   };
+   *
+   *   (async () => {
+   *     const {data, res, paging} = await deviceRegistrationService.list(filter);
+   *   })();
+   * ```
+   */
+  list(filter?: object): Promise<IResultList<IDeviceRegistration>>;
+  /**
+   * Removes an registration with given id.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * @param {string | number | IIdentified} entityOrId entity or id of the registration.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   const id = 'abc';
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.delete(id);
+   *     // data will be null
+   *   })();
+   * ```
+   */
+  delete(entityOrId: string | number | IIdentified): Promise<IResult<null>>;
+  /**
+   * Accepts the device registration for given id.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * @param {string | number | IIdentified} entityOrId entity or id of registration. Using an entity object one can pass a securityToken as string next to the id.
+   *
+   * @param {string} [securityToken] optional security token to reduce the risk of devices which are not yet registered being taken over by threat actors.
+   *
+   * **Examples**
+   * ```typescript
+   *
+   *   const id = 'abc';
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.accept(id);
+   *   })();
+   * ```
+   *
+   * ```typescript
+   *
+   *   const entity = { id: 'abc', securityToken: '<secretToken>' };
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.accept(entity);
+   *   })();
+   * ```
+   *
+   * ```typescript
+   *
+   *   const id = 'abc';
+   *   const securityToken = '<secretToken>';
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.accept(id, securityToken);
+   *   })();
+   * ```
+   *
+   *  Providing a securityToken within an entity object together with another securityToken as a parameter of the
+   *  method will always use the securityToken of the entity object. In the example below <secretTokenA> is
+   *  used as the value. <secretTokenB> is obsolete and ignored.
+   *
+   * ```typescript
+   *
+   *   const entity = { id: 'abc', securityToken: '<secretTokenA>'};
+   *   const securityToken = '<secretTokenB>';
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.accept(entity, securityToken);
+   *   })();
+   *
+   * ```
+   */
+  accept(entityOrId: string | number | IIdentified, securityToken?: string): Promise<IResult<IDeviceRegistration>>;
+  /**
+   * Accepts the device registration for all registrations in pending acceptance.
+   *
+   * @returns Response wrapped in [[IResultList]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.acceptAll();
+   *   })();
+   * ```
+   */
+  acceptAll(): Promise<IResultList<IDeviceRegistrationAccept>>;
+  /**
+   * Gets limitation information for registering devices to the platform
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.limit();
+   *   })();
+   * ```
+   */
+  limit(): Promise<IResult<IDeviceRegistrationLimit>>;
+  /**
+   * Bootstraps the device with given id.
+   *
+   * @param {string | number | IIdentified} entityOrId entity or id of registration. Using an entity object one can pass a securityToken as string next to the id.
+   * @param options for details see [[IDeviceBootstrapOptions]]
+   * @param {string} [securityToken] optional security token to reduce the risk of devices which are not yet registered being taken over by threat actors.
+   *
+   * **Examples**
+   * ```typescript
+   *
+   *   const id: 'abc';
+   *   const options: IDeviceBootstrapOptions = {
+   *     basicAuthToken: 'Basic dGVuYW50L3VzZXJuYW1lOnBhc3N3b3Jk',
+   *     basicAuth: {
+   *       user: 'username',
+   *       pass: 'password'
+   *     }
+   *   };
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.bootstrap(id, options);
+   *   })();
+   * ```
+   *
+   * ```typescript
+   *
+   *   const entity: { id: '123', securityToken: '<secretToken>'};
+   *   const options: IDeviceBootstrapOptions = {
+   *     basicAuthToken: 'Basic dGVuYW50L3VzZXJuYW1lOnBhc3N3b3Jk',
+   *     basicAuth: {
+   *       user: 'username',
+   *       pass: 'password'
+   *     }
+   *   };
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.bootstrap(entity, options);
+   *   })();
+   * ```
+   *
+   * ```typescript
+   *
+   *   const id: '123';
+   *   const options: IDeviceBootstrapOptions = {
+   *     basicAuthToken: 'Basic dGVuYW50L3VzZXJuYW1lOnBhc3N3b3Jk',
+   *     basicAuth: {
+   *       user: 'username',
+   *       pass: 'password'
+   *     }
+   *   };
+   *  const securityToken: '<secretToken>'
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.bootstrap(id, options, securityToken);
+   *   })();
+   * ```
+   *
+   * Providing a securityToken within an entity object together with another securityToken as a parameter of the
+   * method will always use the securityToken of the entity object. In the example below <secretTokenA> is
+   * used as the value. <secretTokenB> is obsolete and ignored.
+   *
+   * ```typescript
+   *
+   *   const options: IDeviceBootstrapOptions = {
+   *     basicAuthToken: 'Basic dGVuYW50L3VzZXJuYW1lOnBhc3N3b3Jk',
+   *     basicAuth: {
+   *       user: 'username',
+   *       pass: 'password'
+   *     }
+   *   };
+   *  const entity: { id: '123', securityToken: '<secretTokenA>'};
+   *  const securityToken: '<secretTokenB>'
+   *
+   *   (async () => {
+   *     const {data, res} = await deviceRegistrationService.accept(entity, securityToken);
+   *   })();
+   * ```
+   */
+  bootstrap(entityOrId: string | number | IIdentified, options: IDeviceBootstrapOptions, securityToken?: string): Promise<IResult<IDeviceCredentials>>;
+  protected onBeforeCreate(entity: IDeviceRegistrationCreate): IDeviceRegistrationCreate;
+  protected onBeforeUpdate(entity: IDeviceRegistrationCreate): IDeviceRegistrationCreate;
+  protected getDetailUrl(entityOrId: string | number | IIdentified): string;
+  private getSecurityToken;
+}
+//#endregion
+export { DeviceRegistrationService, IDeviceBootstrapOptions };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/device-registration/DeviceRegistrationStatus.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/device-registration/DeviceRegistrationStatus.d.ts
+/**
+ * Device registration can have one of the following states.
+ */
+declare enum DeviceRegistrationStatus {
+  WAITING_FOR_CONNECTION,
+  PENDING_ACCEPTANCE,
+  ACCEPTED,
+  BLOCKED
+}
+//#endregion
+export { DeviceRegistrationStatus };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/device-registration/IDeviceCredentials.d.mts

@@ -0,0 +1,25 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/device-registration/IDeviceCredentials.d.ts
+interface IDeviceCredentials {
+  /**
+   * Device identifier, e.g. IMEI
+   */
+  id: string;
+  /**
+   * New password
+   */
+  password: string;
+  /**
+   * Link to this resource
+   */
+  self: string;
+  /**
+   * Tenant id for authentication
+   */
+  tenantId: string;
+  /**
+   * New username
+   */
+  username: string;
+}
+//#endregion
+export { IDeviceCredentials };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/device-registration/IDeviceRegistration.d.mts

@@ -0,0 +1,79 @@
+import { DeviceRegistrationStatus } from "./DeviceRegistrationStatus.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/device-registration/IDeviceRegistration.d.ts
+interface IDeviceRegistrationCreate {
+  /**
+   * Object for custom fragments
+   */
+  customProperties?: {
+    [key: string]: any;
+  };
+  /**
+   * Identifies the owner of the object
+   */
+  owner?: string;
+  /**
+   * Shows the server-side creation time of the object
+   */
+  creationTime?: string;
+  /**
+   * Identifies the target group
+   */
+  groupId?: string;
+  /**
+   * Unique identifier
+   */
+  id: string;
+  /**
+   * Identifies the type of request, e.g.: c8y_DataBroker. For device requests value is normally skipped.
+   */
+  type?: string;
+}
+interface IDeviceRegistration extends IDeviceRegistrationCreate {
+  /**
+   * Link to this resource
+   */
+  self: string;
+  /**
+   * Possible state of device registration
+   */
+  status: DeviceRegistrationStatus;
+  /**
+   * Identifies the tenant
+   */
+  tenantId: string;
+  /**
+   * Security token for a device may be required to register successfully
+   */
+  securityToken?: string;
+}
+interface IDeviceRegistrationAccept {
+  /**
+   * Unique identifier of accepted device registration
+   */
+  id: string;
+  /**
+   * Success state of device registration
+   */
+  successful: boolean;
+  /**
+   * Text to describe an error that occurred while registering the device
+   */
+  error?: string;
+}
+interface IDeviceRegistrationLimit {
+  /**
+   * Indicates if the limit is reached
+   */
+  isReached: boolean;
+  /**
+   * Shows the current limit
+   */
+  limit?: number;
+  /**
+   * Shows the current registered device count
+   */
+  deviceCount?: number;
+}
+//#endregion
+export { IDeviceRegistration, IDeviceRegistrationAccept, IDeviceRegistrationCreate, IDeviceRegistrationLimit };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/device-registration/IDeviceRegistrationBulkResult.d.mts

@@ -0,0 +1,29 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/device-registration/IDeviceRegistrationBulkResult.d.ts
+interface IDeviceRegistrationBulkResult {
+  /**
+   * Result list of updated credentials
+   */
+  credentialUpdatedList: any[];
+  /**
+   * Failed creations as list
+   */
+  failedCreationList: any[];
+  /**
+   * Count of all results
+   */
+  numberOfAll: number;
+  /**
+   * Count of newly created
+   */
+  numberOfCreated: number;
+  /**
+   * Count of failed
+   */
+  numberOfFailed: number;
+  /**
+   * Count of successful
+   */
+  numberOfSuccessful: number;
+}
+//#endregion
+export { IDeviceRegistrationBulkResult };

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

@@ -0,0 +1,67 @@
+import { IFetchResponse } from "../core/IFetchResponse.mjs";
+import { IResult } from "../core/IResult.mjs";
+import { Service } from "../core/Service.mjs";
+import { IEvent } from "./IEvent.mjs";
+import { IEventBinary } from "./IEventBinary.mjs";
+import { Stream } from "stream";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/event/EventBinaryService.d.ts
+declare class EventBinaryService extends Service<IEventBinary> {
+  protected baseUrl: string;
+  protected listUrl: string;
+  /**
+   * Uploads an event binary.
+   * @returns Response wrapped in [[IResult]]
+   *
+   * @param {Stream | Buffer | File | Blob} file file to upload.
+   * @param {string | number | IEvent} eventOrId Event or Id of the Event.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   const file = Buffer.from('aaa');
+   *   const eventId: string | number = 123;
+   *
+   *    (async () => {
+   *      const {data, res} = await eventBinaryService.upload(file, eventId);
+   *   })();
+   * ```
+   */
+  upload(file: Stream | Buffer | File | Blob, entityOrId: string | number | IEvent): Promise<IResult<IEventBinary>>;
+  /**
+   * Downloads the binary for a given event.
+   * @returns Response wrapped in [[IFetchResponse]]
+   *
+   * @param {string | number | IEvent} eventOrId Event or Id of the Event.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   const eventId: string | number = 123;
+   *
+   *    (async () => {
+   *      const res = await eventBinaryService.download(eventId);
+   *   })();
+   */
+  download(entityOrId: string | number | IEvent): Promise<IFetchResponse>;
+  /**
+   * Removes the binary for a given event.
+   * @returns Response wrapped in [[IResult]]
+   *
+   * @param {string | number | IEvent} eventOrId Event or Id of the Event.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   const eventId: string | number = 123;
+   *
+   *    (async () => {
+   *      const {data, res} = await eventBinaryService.delete(eventId);
+   *   })();
+   * ```
+   */
+  delete(entityOrId: string | number | IEvent): Promise<IResult<null>>;
+  protected getDetailUrl(entityOrId: string | number | IEvent): string;
+}
+//#endregion
+export { EventBinaryService };

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

@@ -0,0 +1,120 @@
+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 { IEvent } from "./IEvent.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/event/EventService.d.ts
+/**
+ * This class allows managing for events.
+ */
+declare class EventService extends Service<IEvent> {
+  protected baseUrl: string;
+  protected listUrl: string;
+  protected propertyName: string;
+  protected channel: string;
+  /**
+   * Gets the details of a specific event.
+   *
+   * @param {string|number|IIdentified} entityOrId Entity or Id of the entity.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const eventId: number = 1;
+   *
+   *    (async () => {
+   *      const {data, res} = await eventService.detail(eventId);
+   *   })();
+   * ```
+   */
+  detail(entityOrId: string | number | IIdentified): Promise<IResult<IEvent>>;
+  /**
+   * Creates a new event.
+   *
+   * @param {IEvent} entity Event object with mandantory fragments.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const mandantoryObject: IEvent = {
+   *    source: device,
+   *    text: 'I am an Event!',
+   *    time: '2018-05-02T10:08:00Z',
+   *    type: 'device-type-here',
+   *  };
+   *
+   *  (async () => {
+   *    const {data, res} = await eventService.create(mandantoryObject);
+   *  })();
+   * ```
+   */
+  create(entity: IEvent): Promise<IResult<IEvent>>;
+  /**
+   * Updates event data.
+   *
+   * @param {Partial<IEvent>} entity Event is partially updatable.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const partialUpdateObject: Partial<IEvent> = {
+   *    source: device,
+   *    text: 'Changed Event!'
+   *  };
+   *
+   *  (async () => {
+   *    const {data, res} = await eventService.update(partialUpdateObject);
+   *  })();
+   * ```
+   */
+  update(entity: Partial<IEvent>): Promise<IResult<IEvent>>;
+  /**
+   * Gets the list of events filtered by parameters.
+   *
+   * @returns Response wrapped in [[IResultList]]
+   *
+   * @param {object} filter Object containing filters for querying events.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const filter: object = {
+   *     pageSize: 100,
+   *     withTotalPages: true
+   *   };
+   *
+   *   (async () => {
+   *     const {data, res, paging} = await eventService.list(filter);
+   *   })();
+   * ```
+   */
+  list(filter?: object): Promise<IResultList<IEvent>>;
+  /**
+   * Removes an event with given id.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * @param {string | number | IIdentified} entityOrId entity or id of the event.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const eventId: number = 1;
+   *
+   *   (async () => {
+   *     const {data, res} = await eventService.delete(eventId);
+   *     // data will be null
+   *   })();
+   * ```
+   */
+  delete(entityOrId: string | number | IIdentified): Promise<IResult<null>>;
+}
+//#endregion
+export { EventService };

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

@@ -0,0 +1,42 @@
+import { ISource } from "../core/ISource.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/event/IEvent.d.ts
+/**
+ * This interface holds all fragments that describe an event object
+ */
+interface IEvent {
+  /**
+   * The ManagedObject that the event originated from, see [[ISource]]
+   */
+  source: ISource;
+  /**
+   * Identifies the type of this event
+   */
+  type: string;
+  /**
+   * Time of the event
+   */
+  time: string;
+  /**
+   * Text description of the event
+   */
+  text: string;
+  /**
+   * Uniquely identifies an event
+   */
+  id?: string | number;
+  /**
+   * Link to this resource
+   */
+  self?: string;
+  /**
+   * Time when event was created in the database
+   */
+  creationTime?: string;
+  /**
+   * Custom fragments
+   */
+  [key: string]: any;
+}
+//#endregion
+export { IEvent };

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

@@ -0,0 +1,28 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/event/IEventBinary.d.ts
+/**
+ * This interface specifies all fragments that describe an event binary.
+ */
+interface IEventBinary {
+  /**
+   * Binary name
+   */
+  name: string;
+  /**
+   * Link to this resource
+   */
+  self?: string;
+  /**
+   * The Event that the binary belongs to
+   */
+  source?: string;
+  /**
+   * Binary file length
+   */
+  length?: number;
+  /**
+   * MIME type of the binary file
+   */
+  type?: string;
+}
+//#endregion
+export { IEventBinary };