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/feature/FeatureService.d.mts

@@ -0,0 +1,59 @@
+import { IResultList } from "../core/IResultList.mjs";
+import { IResult } from "../core/IResult.mjs";
+import { Service } from "../core/Service.mjs";
+import { FeatureToggleQueryFilter, IFeatureToggle } from "./IFeatureToggle.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/feature/FeatureService.d.ts
+/**
+ * This class allows reading a feature toggles for current tenant.
+ */
+declare class FeatureService extends Service<IFeatureToggle> {
+  protected baseUrl: string;
+  protected listUrl: string;
+  /**
+   * Retrieve list of feature toggles with values for current tenant.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const filter = {
+   *   pageSize: 1000,
+   *   withTotalPages: true
+   *  };
+   *
+   *   (async () => {
+   *     const {data, res, paging} = await featureService.list(filter);
+   *   })();
+   * ```
+   */
+  list(filter?: FeatureToggleQueryFilter): Promise<IResultList<IFeatureToggle>>;
+  /**
+   * Retrieve a specific feature toggle with value for current tenant.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   (async () => {
+   *     const featureToggleKey = 'my-custom-feature';
+   *     const {data, res} = await featureService.detail(featureToggleKey);
+   *   })();
+   * ```
+   */
+  detail(key: string): Promise<IResult<IFeatureToggle>>;
+  /**
+   * Update a specific feature toggle value for current tenant.
+   *
+   * **Example**
+   * ```typescript
+   *  (async () => {
+   *     const featureToggleKey = 'my-custom-feature';
+   *     const {data, res} = await featureService.updateFeature({
+   *       key: featureToggleKey,
+   *       active: true,
+   *     });
+   * ```
+   */
+  updateFeature(feature: Partial<Omit<IFeatureToggle, 'key'>> & Pick<IFeatureToggle, 'key'>): Promise<IResult<IFeatureToggle>>;
+}
+//#endregion
+export { FeatureService };

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

@@ -0,0 +1,30 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/feature/IFeatureToggle.d.ts
+/**
+ * Represents the properties of the feature toggle
+ * with value for current tenant and the strategy that provided this value.
+ */
+interface IFeatureToggle {
+  /**
+   * Feature key.
+   */
+  key: string;
+  /**
+   * Specifies the current phase of a given feature.
+   */
+  phase: 'IN_DEVELOPMENT' | 'PRIVATE_PREVIEW' | 'PUBLIC_PREVIEW' | 'GENERALLY_AVAILABLE';
+  /**
+   * Indicates whether the given feature is active.
+   */
+  active: boolean;
+  /**
+   * Indicates whether the feature toggle applies to the platform or the tenant.
+   */
+  strategy: 'DEFAULT' | 'TENANT';
+}
+interface FeatureToggleQueryFilter {
+  pageSize?: number;
+  withTotalPages?: boolean;
+  [key: string]: any;
+}
+//#endregion
+export { FeatureToggleQueryFilter, IFeatureToggle };

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

@@ -0,0 +1,27 @@
+import { IIdentified } from "../core/IIdentified.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/identity/IExternalIdentity.d.ts
+/**
+ * This interface holds all fragments that can be used to define
+ * an identity object.
+ */
+interface IExternalIdentity {
+  /**
+   * The identifier used in the external system that Cumulocity interfaces with
+   */
+  externalId: string;
+  /**
+   * The type of the external identifier as string, e.g., "com_cumulocity_model_idtype_SerialNumber"
+   */
+  type: string;
+  /**
+   * The ManagedObject linked to the external ID
+   */
+  managedObject?: IIdentified;
+  /**
+   * Link to this resource
+   */
+  self?: string;
+}
+//#endregion
+export { IExternalIdentity };

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

@@ -0,0 +1,107 @@
+import { IFetchClient } from "../core/IFetchClient.mjs";
+import { IResultList } from "../core/IResultList.mjs";
+import { IResult } from "../core/IResult.mjs";
+import { IExternalIdentity } from "./IExternalIdentity.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/identity/IdentityService.d.ts
+/**
+ * This class allwos for managing external identifiers.
+ */
+declare class IdentityService {
+  private baseUrl;
+  private propertyName;
+  private client;
+  constructor(client: IFetchClient);
+  /**
+   * Gets the list of identities filtered by parameters.
+   *
+   * @returns Response wrapped in [[IResultList]]
+   *
+   * @param {object} filter Object containing filters for querying identity.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const filter: object = {
+   *     pageSize: 100,
+   *     withTotalPages: true
+   *   };
+   *
+   *   (async () => {
+   *     const {data, res, paging} = await identityService.list(filter);
+   *   })();
+   * ```
+   */
+  list(managedObjectId: string): Promise<IResultList<IExternalIdentity>>;
+  /**
+   * Creates a new identity.
+   *
+   * @param {IExternalIdentity} identity Identity object with mandantory fragments.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *   const linkedManagedObjectId = '123';
+   *   const identity: IExternalIdentity = {
+   *      type: 'type',
+   *      externalId: '1',
+   *      managedObject: {
+   *        id: linkedManagedObjectId
+   *      }
+   *    };
+   *
+   *    (async () => {
+   *      const {data, res} = await identityService.create(identity);
+   *   })();
+   * ```
+   */
+  create(identity: IExternalIdentity): Promise<IResult<IExternalIdentity>>;
+  /**
+   * Gets the details of an identity.
+   *
+   * @param {IExternalIdentity} identity Identity object with mandantory fragments.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const identity: IExternalIdentity = {
+   *      type: 'type',
+   *      externalId: '1'
+   *    };
+   *
+   *    (async () => {
+   *      const {data, res} = await identityService.detail(identity);
+   *   })();
+   * ```
+   */
+  detail(identity: IExternalIdentity): Promise<IResult<IExternalIdentity>>;
+  /**
+   * Removes an identity with given id.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * @param {IExternalIdentity} identity Identity object with mandantory fragments.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   const identity: IExternalIdentity = {
+   *      type: 'type',
+   *      externalId: '1'
+   *    };
+   *
+   *    (async () => {
+   *      const {data, res} = await identityService.delete(identity);
+   *   })();
+   * ```
+   */
+  delete(identity: IExternalIdentity): Promise<IResult<IExternalIdentity>>;
+  private fetch;
+  private getExternalIdsOfGlobalIdUrl;
+  private getExternalIdUrl;
+}
+//#endregion
+export { IdentityService };

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

@@ -0,0 +1,95 @@
+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/inventory/IManagedObject.d.ts
+interface IManagedObjectReference {
+  /**
+   * ManagedObject data itself with mandantory fragments of [[ISource]] at least
+   */
+  managedObject: ISource;
+  /**
+   * Link to this resource
+   */
+  self?: string;
+}
+interface IManagedObjectReferences {
+  /**
+   * References array of type [[IManagedObjectReference]]
+   */
+  references: IManagedObjectReference[];
+  /**
+   * Link to this resource
+   */
+  self?: string;
+  /**
+   * Total number of references
+   */
+  count?: number;
+}
+interface IManagedObject {
+  /**
+   * Time when ManagedObject was created in the database
+   */
+  creationTime: string;
+  /**
+   * Unique identifier of the object, automatically allocated when the object is created
+   */
+  id: string;
+  /**
+   * The time when the object was last updated
+   */
+  lastUpdated: string;
+  /**
+   * The owner of the managed object
+   */
+  owner: string;
+  /**
+   * Link to this resource
+   */
+  self: string;
+  /**
+   * A collection of references to additional parents objects
+   */
+  additionParents: IManagedObjectReferences;
+  /**
+   * A collection of references to device parent objects
+   */
+  assetParents: IManagedObjectReferences;
+  /**
+   * A collection of references to child addition objects
+   */
+  childAdditions: IManagedObjectReferences;
+  /**
+   * A collection of references to child assets
+   */
+  childAssets: IManagedObjectReferences;
+  /**
+   * A collection of references to child devices
+   */
+  childDevices: IManagedObjectReferences;
+  /**
+   * A collection of references to device parent objects
+   */
+  deviceParents: IManagedObjectReferences;
+  /**
+   * Custom fragments
+   */
+  [key: string]: any;
+}
+interface IManagedObjectBinary extends Partial<IManagedObject> {
+  c8y_IsBinary: object;
+  length: number;
+  name: string;
+  type: string;
+  contentType: string;
+  _attachments?: {
+    [key: string]: {
+      stub: boolean;
+      length: number;
+      digest: string;
+      revpos: number;
+      content_type: string;
+    };
+  };
+}
+//#endregion
+export { IManagedObject, IManagedObjectBinary, IManagedObjectReference, IManagedObjectReferences };

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

@@ -0,0 +1,50 @@
+import { IFetchOptions } from "../core/IFetchOptions.mjs";
+import { IFetchResponse } from "../core/IFetchResponse.mjs";
+import { IResultList } from "../core/IResultList.mjs";
+import { IResult } from "../core/IResult.mjs";
+import { Service } from "../core/Service.mjs";
+import { IManagedObject, IManagedObjectBinary } from "./IManagedObject.mjs";
+import { IdReference } from "./InventoryService.mjs";
+import { Stream } from "stream";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/inventory/InventoryBinaryService.d.ts
+declare class InventoryBinaryService extends Service<IManagedObjectBinary> {
+  protected baseUrl: string;
+  protected listUrl: string;
+  protected propertyName: string;
+  /**
+   * Uploads a file and creates a managed object with its metadata.
+   * @param file A file to be uploaded.
+   * @param managedObject An object containing metadata about the file.
+   * Note that you can specify `fileType` and `fileName` in case `file` does not define them
+   * but these two properties will be removed from `managedObject` before saving.
+   */
+  create(file: Stream | Buffer | File | Blob, managedObject?: Partial<IManagedObject>): Promise<IResult<IManagedObjectBinary>>;
+  list(filter?: object): Promise<IResultList<IManagedObjectBinary>>;
+  delete(managedObjectOrId: IdReference): Promise<IResult<null>>;
+  download(managedObjectOrId: IdReference, init?: IFetchOptions): Promise<IFetchResponse>;
+  /**
+   * Uploads a file and creates a managed object with its metadata. What's more, it invokes an upload progress callback.
+   * @param file A file to be uploaded.
+   * @param managedObject An object containing metadata about the file.
+   * @param onProgress Event handler for progress update, invoked while the browser is uploading the file.
+   */
+  createWithProgress(file: Stream | Buffer | File | Blob, onProgress: EventListener, managedObject?: Partial<IManagedObject>): XMLHttpRequest;
+  getXMLHttpResponse(xhr: any): Promise<IResult<IManagedObjectBinary>>;
+  /**
+   * Gets binary managed object's id from its download or self URL.
+   *
+   * @param {string} url URL string.
+   *
+   * @returns {number} Binary managed object's id.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   const id = InventoryBinaryService.getIdFromUrl('http://mytenant.cumulocity.com/inventory/binaries/12345');
+   * ```
+   */
+  getIdFromUrl(url: string): string;
+}
+//#endregion
+export { InventoryBinaryService };