aws-iot-device-sdk-v2 - npm Package Compare versions

Comparing version 1.13.5 to 1.14.0

dist/greengrasscoreipc/client.d.ts

@@ -63,2 +63,13 @@ /// <reference types="node" />
     /**
+     * Performs a CancelLocalDeployment operation.
+     *
+     * Cancel a local deployment on the device.
+     *
+     * @param request data describing the CancelLocalDeployment operation to perform
+     * @param options additional eventstream options to use while performing this operation
+     * @return a Promise that is resolved with the CancelLocalDeployment operation's result, or rejected with an
+     *    RpcError
+     */
+    cancelLocalDeployment(request: model.CancelLocalDeploymentRequest, options?: eventstream_rpc.OperationOptions): Promise<model.CancelLocalDeploymentResponse>;
+    /**
      * Performs a CreateDebugPassword operation.
@@ -65,0 +76,0 @@ *

dist/greengrasscoreipc/client.js

@@ -122,2 +122,23 @@ "use strict";
     /**
+     * Performs a CancelLocalDeployment operation.
+     *
+     * Cancel a local deployment on the device.
+     *
+     * @param request data describing the CancelLocalDeployment operation to perform
+     * @param options additional eventstream options to use while performing this operation
+     * @return a Promise that is resolved with the CancelLocalDeployment operation's result, or rejected with an
+     *    RpcError
+     */
+    cancelLocalDeployment(request, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let operationConfig = {
+                name: "aws.greengrass#CancelLocalDeployment",
+                client: this.rpcClient,
+                options: (options) ? options : {}
+            };
+            let operation = new eventstream_rpc.RequestResponseOperation(operationConfig, this.serviceModel);
+            return yield operation.activate(request);
+        });
+    }
+    /**
      * Performs a CreateDebugPassword operation.
@@ -124,0 +145,0 @@ *

dist/greengrasscoreipc/model_utils.d.ts

@@ -7,2 +7,3 @@ import * as model from "./model";
 export declare function normalizeSystemResourceLimits(value: model.SystemResourceLimits): any;
+export declare function normalizeDeploymentStatusDetails(value: model.DeploymentStatusDetails): any;
 export declare function normalizeMessageContext(value: model.MessageContext): any;
@@ -53,2 +54,4 @@ export declare function normalizeRunWithInfo(value: model.RunWithInfo): any;
 export declare function normalizeListNamedShadowsForThingRequest(value: model.ListNamedShadowsForThingRequest): any;
+export declare function normalizeCancelLocalDeploymentResponse(value: model.CancelLocalDeploymentResponse): any;
+export declare function normalizeCancelLocalDeploymentRequest(value: model.CancelLocalDeploymentRequest): any;
 export declare function normalizeUpdateStateResponse(value: model.UpdateStateResponse): any;
@@ -115,2 +118,3 @@ export declare function normalizeUpdateStateRequest(value: model.UpdateStateRequest): any;
 export declare function validateSystemResourceLimits(value: model.SystemResourceLimits): void;
+export declare function validateDeploymentStatusDetails(value: model.DeploymentStatusDetails): void;
 export declare function validateMessageContext(value: model.MessageContext): void;
@@ -161,2 +165,4 @@ export declare function validateRunWithInfo(value: model.RunWithInfo): void;
 export declare function validateListNamedShadowsForThingRequest(value: model.ListNamedShadowsForThingRequest): void;
+export declare function validateCancelLocalDeploymentResponse(value: model.CancelLocalDeploymentResponse): void;
+export declare function validateCancelLocalDeploymentRequest(value: model.CancelLocalDeploymentRequest): void;
 export declare function validateUpdateStateResponse(value: model.UpdateStateResponse): void;
@@ -223,2 +229,3 @@ export declare function validateUpdateStateRequest(value: model.UpdateStateRequest): void;
 export declare function deserializeSystemResourceLimits(value: model.SystemResourceLimits): model.SystemResourceLimits;
+export declare function deserializeDeploymentStatusDetails(value: model.DeploymentStatusDetails): model.DeploymentStatusDetails;
 export declare function deserializeMessageContext(value: model.MessageContext): model.MessageContext;
@@ -269,2 +276,4 @@ export declare function deserializeRunWithInfo(value: model.RunWithInfo): model.RunWithInfo;
 export declare function deserializeListNamedShadowsForThingRequest(value: model.ListNamedShadowsForThingRequest): model.ListNamedShadowsForThingRequest;
+export declare function deserializeCancelLocalDeploymentResponse(value: model.CancelLocalDeploymentResponse): model.CancelLocalDeploymentResponse;
+export declare function deserializeCancelLocalDeploymentRequest(value: model.CancelLocalDeploymentRequest): model.CancelLocalDeploymentRequest;
 export declare function deserializeUpdateStateResponse(value: model.UpdateStateResponse): model.UpdateStateResponse;
@@ -380,2 +389,3 @@ export declare function deserializeUpdateStateRequest(value: model.UpdateStateRequest): model.UpdateStateRequest;
 export declare function deserializeEventstreamMessageToValidateConfigurationUpdateEvents(message: eventstream.Message): model.ValidateConfigurationUpdateEvents;
+export declare function deserializeEventstreamMessageToCancelLocalDeploymentResponse(message: eventstream.Message): model.CancelLocalDeploymentResponse;
 export declare function serializeGetComponentDetailsRequestToEventstreamMessage(request: model.GetComponentDetailsRequest): eventstream.Message;
@@ -401,2 +411,3 @@ export declare function serializePublishToTopicRequestToEventstreamMessage(request: model.PublishToTopicRequest): eventstream.Message;
 export declare function serializeSubscribeToTopicRequestToEventstreamMessage(request: model.SubscribeToTopicRequest): eventstream.Message;
+export declare function serializeCancelLocalDeploymentRequestToEventstreamMessage(request: model.CancelLocalDeploymentRequest): eventstream.Message;
 export declare function serializeSubscribeToCertificateUpdatesRequestToEventstreamMessage(request: model.SubscribeToCertificateUpdatesRequest): eventstream.Message;
@@ -403,0 +414,0 @@ export declare function serializeSubscribeToValidateConfigurationUpdatesRequestToEventstreamMessage(request: model.SubscribeToValidateConfigurationUpdatesRequest): eventstream.Message;

dist/greengrasscoreipc/model.d.ts

@@ -6,2 +6,12 @@ /**
 import { eventstream } from "aws-crt";
+/**
+ * To preserve backwards compatibility, no validation is performed on enum-valued fields.
+ */
+export declare enum DetailedDeploymentStatus {
+    SUCCESSFUL = "SUCCESSFUL",
+    FAILED_NO_STATE_CHANGE = "FAILED_NO_STATE_CHANGE",
+    FAILED_ROLLBACK_NOT_REQUESTED = "FAILED_ROLLBACK_NOT_REQUESTED",
+    FAILED_ROLLBACK_COMPLETE = "FAILED_ROLLBACK_COMPLETE",
+    REJECTED = "REJECTED"
+}
 export interface UserProperty {
@@ -21,2 +31,20 @@ key?: string;
 }
+export interface DeploymentStatusDetails {
+    /**
+     * The detailed deployment status of the local deployment.
+     */
+    detailedDeploymentStatus: DetailedDeploymentStatus;
+    /**
+     * (Optional) The list of local deployment errors
+     */
+    deploymentErrorStack?: string[];
+    /**
+     * (Optional) The list of local deployment error types
+     */
+    deploymentErrorTypes?: string[];
+    /**
+     * (Optional) The cause of local deployment failure
+     */
+    deploymentFailureCause?: string;
+}
 /**
@@ -29,3 +57,4 @@ * To preserve backwards compatibility, no validation is performed on enum-valued fields.
     SUCCEEDED = "SUCCEEDED",
-    FAILED = "FAILED"
+    FAILED = "FAILED",
+    CANCELED = "CANCELED"
 }
@@ -95,2 +124,10 @@ /**
     status: DeploymentStatus;
+    /**
+     * (Optional) The timestamp at which the local deployment was created in MM/dd/yyyy hh:mm:ss format
+     */
+    createdOn?: string;
+    /**
+     * (Optional) The status details of the local deployment.
+     */
+    deploymentStatusDetails?: DeploymentStatusDetails;
 }
@@ -266,2 +303,9 @@ export interface PostComponentUpdateEvent {
  */
+export declare enum FailureHandlingPolicy {
+    ROLLBACK = "ROLLBACK",
+    DO_NOTHING = "DO_NOTHING"
+}
+/**
+ * To preserve backwards compatibility, no validation is performed on enum-valued fields.
+ */
 export declare enum RequestStatus {
@@ -436,2 +480,6 @@ SUCCEEDED = "SUCCEEDED",
     artifactsDirectoryPath?: string;
+    /**
+     * Deployment failure handling policy.
+     */
+    failureHandlingPolicy?: FailureHandlingPolicy;
 }
@@ -513,2 +561,11 @@ export interface ResourceNotFoundError {
 }
+export interface CancelLocalDeploymentResponse {
+    message?: string;
+}
+export interface CancelLocalDeploymentRequest {
+    /**
+     * (Optional) The ID of the local deployment to cancel.
+     */
+    deploymentId?: string;
+}
 export interface UpdateStateResponse {
@@ -515,0 +572,0 @@ }

dist/greengrasscoreipc/model.js

@@ -7,6 +7,17 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QOS = exports.ReceiveMode = exports.ReportedLifecycleState = exports.RequestStatus = exports.CertificateType = exports.ConfigurationValidityStatus = exports.PayloadFormat = exports.MetricUnitType = exports.LifecycleState = exports.DeploymentStatus = void 0;
+exports.QOS = exports.ReceiveMode = exports.ReportedLifecycleState = exports.RequestStatus = exports.FailureHandlingPolicy = exports.CertificateType = exports.ConfigurationValidityStatus = exports.PayloadFormat = exports.MetricUnitType = exports.LifecycleState = exports.DeploymentStatus = exports.DetailedDeploymentStatus = void 0;
 /**
  * To preserve backwards compatibility, no validation is performed on enum-valued fields.
  */
+var DetailedDeploymentStatus;
+(function (DetailedDeploymentStatus) {
+    DetailedDeploymentStatus["SUCCESSFUL"] = "SUCCESSFUL";
+    DetailedDeploymentStatus["FAILED_NO_STATE_CHANGE"] = "FAILED_NO_STATE_CHANGE";
+    DetailedDeploymentStatus["FAILED_ROLLBACK_NOT_REQUESTED"] = "FAILED_ROLLBACK_NOT_REQUESTED";
+    DetailedDeploymentStatus["FAILED_ROLLBACK_COMPLETE"] = "FAILED_ROLLBACK_COMPLETE";
+    DetailedDeploymentStatus["REJECTED"] = "REJECTED";
+})(DetailedDeploymentStatus = exports.DetailedDeploymentStatus || (exports.DetailedDeploymentStatus = {}));
+/**
+ * To preserve backwards compatibility, no validation is performed on enum-valued fields.
+ */
 var DeploymentStatus;
@@ -18,2 +29,3 @@ (function (DeploymentStatus) {
     DeploymentStatus["FAILED"] = "FAILED";
+    DeploymentStatus["CANCELED"] = "CANCELED";
 })(DeploymentStatus = exports.DeploymentStatus || (exports.DeploymentStatus = {}));
@@ -72,2 +84,10 @@ /**
  */
+var FailureHandlingPolicy;
+(function (FailureHandlingPolicy) {
+    FailureHandlingPolicy["ROLLBACK"] = "ROLLBACK";
+    FailureHandlingPolicy["DO_NOTHING"] = "DO_NOTHING";
+})(FailureHandlingPolicy = exports.FailureHandlingPolicy || (exports.FailureHandlingPolicy = {}));
+/**
+ * To preserve backwards compatibility, no validation is performed on enum-valued fields.
+ */
 var RequestStatus;
@@ -74,0 +94,0 @@ (function (RequestStatus) {

lib/greengrasscoreipc/client.ts

@@ -113,2 +113,24 @@ /*
     /**
+     * Performs a CancelLocalDeployment operation.
+     *
+     * Cancel a local deployment on the device.
+     *
+     * @param request data describing the CancelLocalDeployment operation to perform
+     * @param options additional eventstream options to use while performing this operation
+     * @return a Promise that is resolved with the CancelLocalDeployment operation's result, or rejected with an
+     *    RpcError
+     */
+    async cancelLocalDeployment(request : model.CancelLocalDeploymentRequest, options?: eventstream_rpc.OperationOptions) : Promise<model.CancelLocalDeploymentResponse> {
+        let operationConfig = {
+            name: "aws.greengrass#CancelLocalDeployment",
+            client: this.rpcClient,
+            options: (options) ? options : {}
+        };
+
+        let operation = new eventstream_rpc.RequestResponseOperation<model.CancelLocalDeploymentRequest, model.CancelLocalDeploymentResponse>(operationConfig, this.serviceModel);
+
+        return await operation.activate(request);
+    }
+
+    /**
      * Performs a CreateDebugPassword operation.
@@ -115,0 +137,0 @@ *

lib/greengrasscoreipc/model.ts

@@ -16,2 +16,19 @@ /*
 
+/**
+ * To preserve backwards compatibility, no validation is performed on enum-valued fields.
+ */
+export enum DetailedDeploymentStatus {
+
+    SUCCESSFUL = "SUCCESSFUL",
+
+    FAILED_NO_STATE_CHANGE = "FAILED_NO_STATE_CHANGE",
+
+    FAILED_ROLLBACK_NOT_REQUESTED = "FAILED_ROLLBACK_NOT_REQUESTED",
+
+    FAILED_ROLLBACK_COMPLETE = "FAILED_ROLLBACK_COMPLETE",
+
+    REJECTED = "REJECTED"
+
+}
+
 export interface UserProperty {
@@ -39,2 +56,26 @@
 
+export interface DeploymentStatusDetails {
+
+    /**
+     * The detailed deployment status of the local deployment.
+     */
+    detailedDeploymentStatus: DetailedDeploymentStatus,
+
+    /**
+     * (Optional) The list of local deployment errors
+     */
+    deploymentErrorStack?: string[],
+
+    /**
+     * (Optional) The list of local deployment error types
+     */
+    deploymentErrorTypes?: string[],
+
+    /**
+     * (Optional) The cause of local deployment failure
+     */
+    deploymentFailureCause?: string
+
+}
+
 /**
@@ -51,4 +92,6 @@ * To preserve backwards compatibility, no validation is performed on enum-valued fields.
 
-    FAILED = "FAILED"
+    FAILED = "FAILED",
 
+    CANCELED = "CANCELED"
+
 }
@@ -150,4 +193,14 @@
      */
-    status: DeploymentStatus
+    status: DeploymentStatus,
 
+    /**
+     * (Optional) The timestamp at which the local deployment was created in MM/dd/yyyy hh:mm:ss format
+     */
+    createdOn?: string,
+
+    /**
+     * (Optional) The status details of the local deployment.
+     */
+    deploymentStatusDetails?: DeploymentStatusDetails
+
 }
@@ -388,2 +441,13 @@
  */
+export enum FailureHandlingPolicy {
+
+    ROLLBACK = "ROLLBACK",
+
+    DO_NOTHING = "DO_NOTHING"
+
+}
+
+/**
+ * To preserve backwards compatibility, no validation is performed on enum-valued fields.
+ */
 export enum RequestStatus {
@@ -638,4 +702,9 @@
      */
-    artifactsDirectoryPath?: string
+    artifactsDirectoryPath?: string,
 
+    /**
+     * Deployment failure handling policy.
+     */
+    failureHandlingPolicy?: FailureHandlingPolicy
+
 }
@@ -760,2 +829,17 @@
 
+export interface CancelLocalDeploymentResponse {
+
+    message?: string
+
+}
+
+export interface CancelLocalDeploymentRequest {
+
+    /**
+     * (Optional) The ID of the local deployment to cancel.
+     */
+    deploymentId?: string
+
+}
+
 export interface UpdateStateResponse {
@@ -762,0 +846,0 @@

package.json

 {
   "name": "aws-iot-device-sdk-v2",
-  "version": "1.13.5",
+  "version": "1.14.0",
   "description": "NodeJS API for the AWS IoT service",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/aws/aws-iot-device-sdk-js-v2",

README.md

@@ -136,2 +136,2 @@ # AWS IoT Device SDK for JavaScript v2
 
-Latest released version: v1.13.5
+Latest released version: v1.14.0

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1550036

increased by1.7%

Lines of code

26411

increased by1.48%

No dependency changes