@google-cloud/dlp 3.2.0 → 3.4.0

package/CHANGELOG.md

@@ -4,6 +4,27 @@
 
 [1]: https://www.npmjs.com/package/PACKAGE NAME?activeTab=versions
 
+## [3.4.0](https://github.com/googleapis/nodejs-dlp/compare/v3.3.0...v3.4.0) (2022-03-25)
+
+
+### Features
+
+* new Bytes and File types: POWERPOINT and EXCEL ([#693](https://github.com/googleapis/nodejs-dlp/issues/693)) ([ed3dc42](https://github.com/googleapis/nodejs-dlp/commit/ed3dc42bce256100a62528481c7ec10362f7fa93))
+
+## [3.3.0](https://www.github.com/googleapis/nodejs-dlp/compare/v3.2.1...v3.3.0) (2021-12-03)
+
+
+### Features
+
+* added deidentify replacement dictionaries feat: added field for BigQuery inspect template inclusion lists feat: added field to support infotype versioning ([#667](https://www.github.com/googleapis/nodejs-dlp/issues/667)) ([7f8b9d6](https://www.github.com/googleapis/nodejs-dlp/commit/7f8b9d6dc33837f5b93a0b2269ca79572520b14c))
+
+### [3.2.1](https://www.github.com/googleapis/nodejs-dlp/compare/v3.2.0...v3.2.1) (2021-11-03)
+
+
+### Bug Fixes
+
+* **deps:** update dependency mime to v3 ([#663](https://www.github.com/googleapis/nodejs-dlp/issues/663)) ([5d33ead](https://www.github.com/googleapis/nodejs-dlp/commit/5d33ead5c207511a2ef3d268dd804eabc20408d8))
+
 ## [3.2.0](https://www.github.com/googleapis/nodejs-dlp/compare/v3.1.8...v3.2.0) (2021-08-23)
 
 

package/README.md

@@ -4,9 +4,8 @@
 
 # [Cloud Data Loss Prevention: Node.js Client](https://github.com/googleapis/nodejs-dlp)
 
-[![release level](https://img.shields.io/badge/release%20level-general%20availability%20%28GA%29-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
+[![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
 [![npm version](https://img.shields.io/npm/v/@google-cloud/dlp.svg)](https://www.npmjs.org/package/@google-cloud/dlp)
-[![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-dlp/main.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-dlp)
 
 
 
@@ -166,37 +165,38 @@ also contains samples.
 Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
 Libraries are compatible with all current _active_ and _maintenance_ versions of
 Node.js.
+If you are using an end-of-life version of Node.js, we recommend that you update
+as soon as possible to an actively supported LTS version.
 
-Client libraries targeting some end-of-life versions of Node.js are available, and
-can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
-The dist-tags follow the naming convention `legacy-(version)`.
-
-_Legacy Node.js versions are supported as a best effort:_
-
-* Legacy versions will not be tested in continuous integration.
-* Some security patches may not be able to be backported.
-* Dependencies will not be kept up-to-date, and features will not be backported.
+Google's client libraries support legacy versions of Node.js runtimes on a
+best-efforts basis with the following warnings:
 
-#### Legacy tags available
+* Legacy versions are not tested in continuous integration.
+* Some security patches and features cannot be backported.
+* Dependencies cannot be kept up-to-date.
 
-* `legacy-8`: install client libraries from this dist-tag for versions
-  compatible with Node.js 8.
+Client libraries targeting some end-of-life versions of Node.js are available, and
+can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
+The dist-tags follow the naming convention `legacy-(version)`.
+For example, `npm install @google-cloud/dlp@legacy-8` installs client libraries
+for versions compatible with Node.js 8.
 
 ## Versioning
 
 This library follows [Semantic Versioning](http://semver.org/).
 
 
-This library is considered to be **General Availability (GA)**. This means it
-is stable; the code surface will not change in backwards-incompatible ways
+
+This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways
 unless absolutely necessary (e.g. because of critical security issues) or with
-an extensive deprecation period. Issues and requests against **GA** libraries
+an extensive deprecation period. Issues and requests against **stable** libraries
 are addressed with the highest priority.
 
 
 
 
 
+
 More Information: [Google Cloud Platform Launch Stages][launch_stages]
 
 [launch_stages]: https://cloud.google.com/terms/launch-stages

package/build/protos/google/privacy/dlp/v2/dlp.proto

@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@ syntax = "proto3";
 
 package google.privacy.dlp.v2;
 
+import "google/api/annotations.proto";
 import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
@@ -28,7 +29,6 @@ import "google/rpc/status.proto";
 import "google/type/date.proto";
 import "google/type/dayofweek.proto";
 import "google/type/timeofday.proto";
-import "google/api/annotations.proto";
 
 option csharp_namespace = "Google.Cloud.Dlp.V2";
 option go_package = "google.golang.org/genproto/googleapis/privacy/dlp/v2;dlp";
@@ -360,6 +360,10 @@ service DlpService {
         post: "/v2/{parent=projects/*/locations/*}/jobTriggers"
         body: "*"
       }
+      additional_bindings {
+        post: "/v2/{parent=organizations/*/locations/*}/jobTriggers"
+        body: "*"
+      }
     };
     option (google.api.method_signature) = "parent,job_trigger";
   }
@@ -374,6 +378,10 @@ service DlpService {
         patch: "/v2/{name=projects/*/locations/*/jobTriggers/*}"
         body: "*"
       }
+      additional_bindings {
+        patch: "/v2/{name=organizations/*/locations/*/jobTriggers/*}"
+        body: "*"
+      }
     };
     option (google.api.method_signature) = "name,job_trigger,update_mask";
   }
@@ -381,9 +389,6 @@ service DlpService {
   // Inspect hybrid content and store findings to a trigger. The inspection
   // will be processed asynchronously. To review the findings monitor the
   // jobs within the trigger.
-  // Early access feature is in a pre-release state and might change or have
-  // limited support. For more information, see
-  // https://cloud.google.com/products#product-launch-stages.
   rpc HybridInspectJobTrigger(HybridInspectJobTriggerRequest) returns (HybridInspectResponse) {
     option (google.api.http) = {
       post: "/v2/{name=projects/*/locations/*/jobTriggers/*}:hybridInspect"
@@ -400,6 +405,9 @@ service DlpService {
       additional_bindings {
         get: "/v2/{name=projects/*/locations/*/jobTriggers/*}"
       }
+      additional_bindings {
+        get: "/v2/{name=organizations/*/locations/*/jobTriggers/*}"
+      }
     };
     option (google.api.method_signature) = "name";
   }
@@ -412,6 +420,9 @@ service DlpService {
       additional_bindings {
         get: "/v2/{parent=projects/*/locations/*}/jobTriggers"
       }
+      additional_bindings {
+        get: "/v2/{parent=organizations/*/locations/*}/jobTriggers"
+      }
     };
     option (google.api.method_signature) = "parent";
   }
@@ -424,6 +435,9 @@ service DlpService {
       additional_bindings {
         delete: "/v2/{name=projects/*/locations/*/jobTriggers/*}"
       }
+      additional_bindings {
+        delete: "/v2/{name=organizations/*/locations/*/jobTriggers/*}"
+      }
     };
     option (google.api.method_signature) = "name";
   }
@@ -470,6 +484,9 @@ service DlpService {
       additional_bindings {
         get: "/v2/{parent=projects/*/locations/*}/dlpJobs"
       }
+      additional_bindings {
+        get: "/v2/{parent=organizations/*/locations/*}/dlpJobs"
+      }
     };
     option (google.api.method_signature) = "parent";
   }
@@ -623,11 +640,8 @@ service DlpService {
   }
 
   // Inspect hybrid content and store findings to a job.
-  // To review the findings inspect the job. Inspection will occur
+  // To review the findings, inspect the job. Inspection will occur
   // asynchronously.
-  // Early access feature is in a pre-release state and might change or have
-  // limited support. For more information, see
-  // https://cloud.google.com/products#product-launch-stages.
   rpc HybridInspectDlpJob(HybridInspectDlpJobRequest) returns (HybridInspectResponse) {
     option (google.api.http) = {
       post: "/v2/{name=projects/*/locations/*/dlpJobs/*}:hybridInspect"
@@ -638,9 +652,6 @@ service DlpService {
 
   // Finish a running hybrid DlpJob. Triggers the finalization steps and running
   // of any enabled actions that have not yet run.
-  // Early access feature is in a pre-release state and might change or have
-  // limited support. For more information, see
-  // https://cloud.google.com/products#product-launch-stages.
   rpc FinishDlpJob(FinishDlpJobRequest) returns (google.protobuf.Empty) {
     option (google.api.http) = {
       post: "/v2/{name=projects/*/locations/*/dlpJobs/*}:finish"
@@ -708,7 +719,8 @@ message InspectionRuleSet {
 // When used with redactContent only info_types and min_likelihood are currently
 // used.
 message InspectConfig {
-  // Configuration to control the number of findings returned.
+  // Configuration to control the number of findings returned for inspection.
+  // This is not used for de-identification or data profiling.
   message FindingLimits {
     // Max findings configuration per infoType, per content item or long
     // running DlpJob.
@@ -757,21 +769,23 @@ message InspectConfig {
   Likelihood min_likelihood = 2;
 
   // Configuration to control the number of findings returned.
+  // This is not used for data profiling.
   FindingLimits limits = 3;
 
   // When true, a contextual quote from the data that triggered a finding is
   // included in the response; see Finding.quote.
+  // This is not used for data profiling.
   bool include_quote = 4;
 
   // When true, excludes type information of the findings.
+  // This is not used for data profiling.
   bool exclude_info_types = 5;
 
   // CustomInfoTypes provided by the user. See
   // https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.
   repeated CustomInfoType custom_info_types = 6;
 
-  // List of options defining data content to scan.
-  // If empty, text, images, and other content will be included.
+  // Deprecated and unused.
   repeated ContentOption content_options = 8;
 
   // Set of rules to apply to the findings for this InspectConfig.
@@ -782,7 +796,9 @@ message InspectConfig {
 
 // Container for bytes to inspect or redact.
 message ByteContentItem {
-  // The type of data being sent for inspection.
+  // The type of data being sent for inspection. To learn more, see
+  // [Supported file
+  // types](https://cloud.google.com/dlp/docs/supported-file-types).
   enum BytesType {
     // Unused
     BYTES_TYPE_UNSPECIFIED = 0;
@@ -811,6 +827,12 @@ message ByteContentItem {
     // pdf
     PDF = 8;
 
+    // pptx, pptm, potx, potm, pot
+    POWERPOINT_DOCUMENT = 9;
+
+    // xlsx, xlsm, xltx, xltm
+    EXCEL_DOCUMENT = 10;
+
     // avro
     AVRO = 11;
 
@@ -845,9 +867,9 @@ message ContentItem {
   }
 }
 
-// Structured content to inspect. Up to 50,000 `Value`s per request allowed.
-// See https://cloud.google.com/dlp/docs/inspecting-text#inspecting_a_table to
-// learn more.
+// Structured content to inspect. Up to 50,000 `Value`s per request allowed. See
+// https://cloud.google.com/dlp/docs/inspecting-structured-text#inspecting_a_table
+// to learn more.
 message Table {
   // Values of the row.
   message Row {
@@ -945,6 +967,9 @@ message Finding {
   string job_name = 13 [(google.api.resource_reference) = {
                           type: "dlp.googleapis.com/DlpJob"
                         }];
+
+  // The unique finding id.
+  string finding_id = 15;
 }
 
 // Specifies the location of the finding.
@@ -1488,16 +1513,13 @@ message InspectDataSourceDetails {
     repeated InfoTypeStats info_type_stats = 3;
 
     // Statistics related to the processing of hybrid inspect.
-    // Early access feature is in a pre-release state and might change or have
-    // limited support. For more information, see
-    // https://cloud.google.com/products#product-launch-stages.
     HybridInspectStatistics hybrid_stats = 7;
   }
 
   // The configuration used for this job.
   RequestedOptions requested_options = 2;
 
-  // A summary of the outcome of this inspect job.
+  // A summary of the outcome of this inspection job.
   Result result = 3;
 }
 
@@ -2200,7 +2222,7 @@ message TransformationErrorHandling {
 // A rule for transforming a value.
 message PrimitiveTransformation {
   oneof transformation {
-    // Replace
+    // Replace with a specified value.
     ReplaceValueConfig replace_config = 1;
 
     // Redact
@@ -2232,6 +2254,9 @@ message PrimitiveTransformation {
 
     // Deterministic Crypto
     CryptoDeterministicConfig crypto_deterministic_config = 12;
+
+    // Replace with a value randomly drawn (with replacement) from a dictionary.
+    ReplaceDictionaryConfig replace_dictionary_config = 13;
   }
 }
 
@@ -2282,7 +2307,9 @@ message CryptoHashConfig {
 // input. Outputs a base64 encoded representation of the encrypted output.
 // Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297.
 message CryptoDeterministicConfig {
-  // The key used by the encryption function.
+  // The key used by the encryption function. For deterministic encryption
+  // using AES-SIV, the provided key is internally expanded to 64 bytes prior to
+  // use.
   CryptoKey crypto_key = 1;
 
   // The custom info type to annotate the surrogate with.
@@ -2346,6 +2373,16 @@ message ReplaceValueConfig {
   Value new_value = 1;
 }
 
+// Replace each input value with a value randomly selected from the dictionary.
+message ReplaceDictionaryConfig {
+  oneof type {
+    // A list of words to select from for random replacement. The
+    // [limits](https://cloud.google.com/dlp/limits) page contains details about
+    // the size limits of dictionaries.
+    CustomInfoType.Dictionary.WordList word_list = 1;
+  }
+}
+
 // Replace each matching finding with the name of the info_type.
 message ReplaceWithInfoTypeConfig {
 
@@ -2429,8 +2466,8 @@ message CharacterMaskConfig {
 // the user for simple bucketing strategies.
 //
 // The transformed value will be a hyphenated string of
-// {lower_bound}-{upper_bound}, i.e if lower_bound = 10 and upper_bound = 20
-// all values that are within this bucket will be replaced with "10-20".
+// {lower_bound}-{upper_bound}. For example, if lower_bound = 10 and upper_bound
+// = 20, all values that are within this bucket will be replaced with "10-20".
 //
 // This can be used on data of type: double, long.
 //
@@ -2593,10 +2630,11 @@ message CryptoReplaceFfxFpeConfig {
 }
 
 // This is a data encryption key (DEK) (as opposed to
-// a key encryption key (KEK) stored by KMS).
-// When using KMS to wrap/unwrap DEKs, be sure to set an appropriate
-// IAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot
-// unwrap the data crypto key.
+// a key encryption key (KEK) stored by Cloud Key Management Service
+// (Cloud KMS).
+// When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate
+// IAM policy on the KEK to ensure an attacker cannot
+// unwrap the DEK.
 message CryptoKey {
   // Sources of crypto keys.
   oneof source {
@@ -2606,7 +2644,7 @@ message CryptoKey {
     // Unwrapped crypto key
     UnwrappedCryptoKey unwrapped = 2;
 
-    // Kms wrapped key
+    // Key wrapped using Cloud KMS
     KmsWrappedCryptoKey kms_wrapped = 3;
   }
 }
@@ -2631,10 +2669,16 @@ message UnwrappedCryptoKey {
 }
 
 // Include to use an existing data crypto key wrapped by KMS.
-// The wrapped key must be a 128/192/256 bit key.
+// The wrapped key must be a 128-, 192-, or 256-bit key.
 // Authorization requires the following IAM permissions when sending a request
-// to perform a crypto transformation using a kms-wrapped crypto key:
+// to perform a crypto transformation using a KMS-wrapped crypto key:
 // dlp.kms.encrypt
+//
+// For more information, see [Creating a wrapped key]
+// (https://cloud.google.com/dlp/docs/create-wrapped-key).
+//
+// Note: When you use Cloud KMS for cryptographic operations,
+// [charges apply](https://cloud.google.com/kms/pricing).
 message KmsWrappedCryptoKey {
   // Required. The wrapped data crypto key.
   bytes wrapped_key = 1 [(google.api.field_behavior) = REQUIRED];
@@ -2697,6 +2741,9 @@ message InfoTypeTransformations {
 // The transformation to apply to the field.
 message FieldTransformation {
   // Required. Input field(s) to apply the transformation to.
+  // When you have columns that reference their position within a list,
+  // omit the index from the FieldId. FieldId name matching ignores the index.
+  // For example, instead of "contact.nums[0].type", use "contact.nums.type".
   repeated FieldId fields = 1 [(google.api.field_behavior) = REQUIRED];
 
   // Only apply the transformation if the condition evaluates to true for the
@@ -2818,6 +2865,18 @@ message TransformationOverview {
 // Only one of 'transformation', 'field_transformation', or 'record_suppress'
 // will be set.
 message TransformationSummary {
+  // Possible outcomes of transformations.
+  enum TransformationResultCode {
+    // Unused
+    TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0;
+
+    // Transformation completed without an error.
+    SUCCESS = 1;
+
+    // Transformation had an error.
+    ERROR = 2;
+  }
+
   // A collection that informs the user the number of times a particular
   // `TransformationResultCode` and error details occurred.
   message SummaryResult {
@@ -2832,18 +2891,6 @@ message TransformationSummary {
     string details = 3;
   }
 
-  // Possible outcomes of transformations.
-  enum TransformationResultCode {
-    // Unused
-    TRANSFORMATION_RESULT_CODE_UNSPECIFIED = 0;
-
-    // Transformation completed without an error.
-    SUCCESS = 1;
-
-    // Transformation had an error.
-    ERROR = 2;
-  }
-
   // Set if the transformation was limited to a specific InfoType.
   InfoType info_type = 1;
 
@@ -2868,7 +2915,7 @@ message TransformationSummary {
   int64 transformed_bytes = 7;
 }
 
-// Schedule for triggeredJobs.
+// Schedule for inspect job triggers.
 message Schedule {
   oneof option {
     // With this option a job is started a regular periodic basis. For
@@ -2955,7 +3002,7 @@ message DeidentifyTemplate {
   // Output only. The last update timestamp of an inspectTemplate.
   google.protobuf.Timestamp update_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // ///////////// // The core content of the template  // ///////////////
+  // The core content of the template.
   DeidentifyConfig deidentify_config = 6;
 }
 
@@ -2985,9 +3032,6 @@ message JobTrigger {
       Schedule schedule = 1;
 
       // For use with hybrid jobs. Jobs must be manually created and finished.
-      // Early access feature is in a pre-release state and might change or have
-      // limited support. For more information, see
-      // https://cloud.google.com/products#product-launch-stages.
       Manual manual = 2;
     }
   }
@@ -3090,11 +3134,11 @@ message Action {
 
   }
 
-  // Publish findings of a DlpJob to Cloud Data Catalog. Labels summarizing the
+  // Publish findings of a DlpJob to Data Catalog. Labels summarizing the
   // results of the DlpJob will be applied to the entry for the resource scanned
-  // in Cloud Data Catalog. Any labels previously written by another DlpJob will
+  // in Data Catalog. Any labels previously written by another DlpJob will
   // be deleted. InfoType naming patterns are strictly enforced when using this
-  // feature. Note that the findings will be persisted in Cloud Data Catalog
+  // feature. Note that the findings will be persisted in Data Catalog
   // storage and are governed by Data Catalog service-specific policy, see
   // https://cloud.google.com/terms/service-terms
   // Only a single instance of this action can be specified and only allowed if
@@ -3402,10 +3446,11 @@ message CreateDlpJobRequest {
 
   // The configuration details for the specific type of job to run.
   oneof job {
-    // Set to control what and how to inspect.
+    // An inspection job scans a storage repository for InfoTypes.
     InspectJobConfig inspect_job = 2;
 
-    // Set to choose what metric to calculate.
+    // A risk analysis job calculates re-identification risk metrics for a
+    // BigQuery table.
     RiskAnalysisJobConfig risk_job = 3;
   }
 
@@ -3477,7 +3522,7 @@ message ListJobTriggersRequest {
   // * Restrictions can be combined by `AND` or `OR` logical operators. A
   // sequence of restrictions implicitly uses `AND`.
   // * A restriction has the form of `{field} {operator} {value}`.
-  // * Supported fields/values for inspect jobs:
+  // * Supported fields/values for inspect triggers:
   //     - `status` - HEALTHY|PAUSED|CANCELLED
   //     - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
   //     - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by
@@ -3495,6 +3540,9 @@ message ListJobTriggersRequest {
   // The length of this field should be no more than 500 characters.
   string filter = 5;
 
+  // The type of jobs. Will use `DlpJobType.INSPECT` if not set.
+  DlpJobType type = 6;
+
   // Deprecated. This field has no effect.
   string location_id = 7;
 }
@@ -4312,7 +4360,7 @@ enum MatchingType {
   MATCHING_TYPE_INVERSE_MATCH = 3;
 }
 
-// Options describing which parts of the provided content should be scanned.
+// Deprecated and unused.
 enum ContentOption {
   // Includes entire content of a file or a data stream.
   CONTENT_UNSPECIFIED = 0;
@@ -4347,7 +4395,7 @@ enum InfoTypeSupportedBy {
 
 // An enum to represent the various types of DLP jobs.
 enum DlpJobType {
-  // Unused
+  // Defaults to INSPECT_JOB.
   DLP_JOB_TYPE_UNSPECIFIED = 0;
 
   // The job inspected Google Cloud for sensitive data.