@hiiretail/gcp-infra-generators 1.0.1 → 1.0.2

package/dist/generators/common-resources/monitoring/templates/alerts/generic-infra.yaml

@@ -19,6 +19,7 @@ cloud_function:
                 - resource.label.function_name
     documentation:
       subject: 'Function: `$${resource.label.function_name}`'
+      content: 'Review the function in Cloud Functions: https://console.cloud.google.com/run?deploymentType=function&project=<%-projectId%>'
 cloud_run:
   error_count:
     display_name: "[P3] <%-clan%> - Cloud Run | Error rate"
@@ -40,6 +41,7 @@ cloud_run:
                 - resource.label.service_name
     documentation:
       subject: 'Service: `$${resource.label.service_name}`'
+      content: 'Review the service in Cloud Run: https://console.cloud.google.com/run?project=<%-projectId%>'
   request_latency:
     display_name: "[P3] <%-clan%> - Cloud Run | Request Latency"
     conditions:
@@ -59,6 +61,7 @@ cloud_run:
                 - resource.label.service_name
     documentation:
       subject: 'Service: `$${resource.label.service_name}`'
+      content: 'Review the service in Cloud Run: https://console.cloud.google.com/run?project=<%-projectId%>'
   cpu_utilization:
     display_name: "[P3] <%-clan%> - Cloud Run | CPU Utilization"
     conditions:
@@ -72,12 +75,13 @@ cloud_run:
           duration: 300s
           aggregations:
             - alignment_period: 60s
-              per_series_aligner: ALIGN_MEAN
+              per_series_aligner: ALIGN_PERCENTILE_99
               cross_series_reducer: REDUCE_PERCENTILE_99
               group_by_fields:
                 - resource.label.service_name
     documentation:
       subject: 'Service: `$${resource.label.service_name}`'
+      content: 'Review the service in Cloud Run: https://console.cloud.google.com/run?project=<%-projectId%>'
   memory_utilization:
     display_name: "[P3] <%-clan%> - Cloud Run | Memory Utilization"
     conditions:
@@ -91,12 +95,13 @@ cloud_run:
           duration: 300s
           aggregations:
             - alignment_period: 60s
-              per_series_aligner: ALIGN_MEAN
+              per_series_aligner: ALIGN_PERCENTILE_99
               cross_series_reducer: REDUCE_PERCENTILE_99
               group_by_fields:
                 - resource.label.service_name
     documentation:
       subject: 'Service: `$${resource.label.service_name}`'
+      content: 'Review the service in Cloud Run: https://console.cloud.google.com/run?project=<%-projectId%>'
   startup_latency:
     display_name: "[P4] <%-clan%> - Cloud Run | Startup Latency"
     conditions:
@@ -116,6 +121,7 @@ cloud_run:
                 - resource.label.service_name
     documentation:
       subject: 'Service: `$${resource.label.service_name}`'
+      content: 'Review the service in Cloud Run: https://console.cloud.google.com/run?project=<%-projectId%>'
 cloud_scheduler:
   failed_job:
     display_name: "[P4] <%-clan%> - Cloud Scheduler | Job Failed"
@@ -135,6 +141,7 @@ cloud_scheduler:
                 - resource.label.job_id
     documentation:
       subject: 'Job: `$${resource.label.job_id}`'
+      content: 'Review the job in Cloud Scheduler: https://console.cloud.google.com/cloudscheduler?project=<%-projectId%>'
   failed_executions:
     display_name: "[P3] <%-clan%> - Cloud Scheduler | Failed Executions"
     conditions:
@@ -155,6 +162,7 @@ cloud_scheduler:
                 - resource.label.job_id
     documentation:
       subject: 'Job: `$${resource.label.job_id}`'
+      content: 'Review the job in Cloud Scheduler: https://console.cloud.google.com/cloudscheduler?project=<%-projectId%>'
 cloud_sql:
   cpu_over_65:
     display_name: "[P3] <%-clan%> - CloudSQL | CPU over 65%"
@@ -175,6 +183,7 @@ cloud_sql:
                 - resource.label.database_id
     documentation:
       subject: 'Database: `$${resource.label.database_id}`'
+      content: 'Review the database in Cloud SQL: https://console.cloud.google.com/sql/instances?project=<%-projectId%>'
   cpu_over_85:
     display_name: "[P3] <%-clan%> - CloudSQL | CPU over 85%"
     conditions:
@@ -194,6 +203,7 @@ cloud_sql:
                 - resource.label.database_id
     documentation:
       subject: 'Database: `$${resource.label.database_id}`'
+      content: 'Review the database in Cloud SQL: https://console.cloud.google.com/sql/instances?project=<%-projectId%>'
   cpu_over_90:
     display_name: "[P3] <%-clan%> - CloudSQL | CPU over 90%"
     conditions:
@@ -213,6 +223,7 @@ cloud_sql:
                 - resource.label.database_id
     documentation:
       subject: 'Database: `$${resource.label.database_id}`'
+      content: 'Review the database in Cloud SQL: https://console.cloud.google.com/sql/instances?project=<%-projectId%>'
   memory_over_90:
     display_name: "[P2] <%-clan%> - CloudSQL | Memory utilization above 90%"
     conditions:
@@ -232,6 +243,7 @@ cloud_sql:
                 - resource.label.database_id
     documentation:
       subject: 'Database: `$${resource.label.database_id}`'
+      content: 'Review the database in Cloud SQL: https://console.cloud.google.com/sql/instances?project=<%-projectId%>'
   query_over_1s:
     display_name: "[P4] <%-clan%> - CloudSQL | Slow query"
     conditions:
@@ -251,6 +263,7 @@ cloud_sql:
                 - resource.label.resource_id
     documentation:
       subject: 'Database: `$${resource.label.resource_id}`'
+      content: 'Review the database in Cloud SQL: https://console.cloud.google.com/sql/instances?project=<%-projectId%>'
   postgresql_connections:
     display_name: "[P3] <%-clan%> - CloudSQL | PostgreSQL Connections"
     conditions:
@@ -269,6 +282,7 @@ cloud_sql:
                 - resource.label.database_id
     documentation:
       subject: 'Database: `$${resource.label.database_id}`'
+      content: 'Review the database in Cloud SQL: https://console.cloud.google.com/sql/instances?project=<%-projectId%>'
   aggregated_lock_time:
     display_name: "[P4] <%-clan%> - CloudSQL | Aggregated Lock Time"
     conditions:
@@ -287,6 +301,7 @@ cloud_sql:
                 - resource.label.database_id
     documentation:
       subject: 'Database: `$${resource.label.database_id}`'
+      content: 'Review the database in Cloud SQL: https://console.cloud.google.com/sql/instances?project=<%-projectId%>'
 firestore:
   request_latencies:
     display_name: "[P3] <%-clan%> - Firestore | High request latencies"
@@ -306,6 +321,7 @@ firestore:
                 - resource.label.database_id
     documentation:
       subject: 'Database: `$${resource.label.database_id}`'
+      content: 'Review the database in Firestore: https://console.cloud.google.com/firestore/databases?project=<%-projectId%>'
   failed_commits:
     display_name: "[P3] <%-clan%> - Firestore | High failed commits errors"
     conditions:
@@ -324,6 +340,9 @@ firestore:
               cross_series_reducer: REDUCE_SUM
               group_by_fields:
                 - metric.label."response_code"
+    documentation:
+      subject: 'Database: `$${resource.label.database_id}`'
+      content: 'Review the database in Firestore: https://console.cloud.google.com/firestore/databases?project=<%-projectId%>'
 memorystore:
   memory_over_50:
     display_name: "[P3] <%-clan%> - Memorystore | Memory over 50%"
@@ -344,6 +363,7 @@ memorystore:
                 - resource.label.instance_id
     documentation:
       subject: 'Instance: `$${resource.label.instance_id}`'
+      content: 'Review the instance in Memorystore: https://console.cloud.google.com/memorystore/redis/instances?project=<%-projectId%>'
   memory_over_75:
     display_name: "[P3] <%-clan%> - Memorystore | Memory over 75%"
     conditions:
@@ -363,6 +383,7 @@ memorystore:
                 - resource.label.instance_id
     documentation:
       subject: 'Instance: `$${resource.label.instance_id}`'
+      content: 'Review the instance in Memorystore: https://console.cloud.google.com/memorystore/redis/instances?project=<%-projectId%>'
   memory_over_90:
     display_name: "[P2] <%-clan%> - Memorystore | Memory over 90%"
     conditions:
@@ -382,6 +403,7 @@ memorystore:
                 - resource.label.instance_id
     documentation:
       subject: 'Instance: `$${resource.label.instance_id}`'
+      content: 'Review the instance in Memorystore: https://console.cloud.google.com/memorystore/redis/instances?project=<%-projectId%>'
   cpu_utilization:
     display_name: "[P2] <%-clan%> - Memorystore | CPU Utilization"
     conditions:
@@ -401,6 +423,7 @@ memorystore:
                 - resource.label.instance_id
     documentation:
       subject: 'Instance: `$${resource.label.instance_id}`'
+      content: 'Review the instance in Memorystore: https://console.cloud.google.com/memorystore/redis/instances?project=<%-projectId%>'
   system_memory_overload_duration:
     display_name: "[P1] <%-clan%> - Memorystore | System Memory Overload Duration"
     conditions:
@@ -419,6 +442,7 @@ memorystore:
                 - resource.label.instance_id
     documentation:
       subject: 'Instance: `$${resource.label.instance_id}`'
+      content: 'Review the instance in Memorystore: https://console.cloud.google.com/memorystore/redis/instances?project=<%-projectId%>'
   calls:
     display_name: "[P3] <%-clan%> - Memorystore | Calls"
     conditions:
@@ -438,6 +462,7 @@ memorystore:
                 - resource.label.instance_id
     documentation:
       subject: 'Instance: `$${resource.label.instance_id}`'
+      content: 'Review the instance in Memorystore: https://console.cloud.google.com/memorystore/redis/instances?project=<%-projectId%>'
 pub_sub:
   unacknowledged_messages:
     display_name: "[P3] <%-clan%> - Pub/Sub | Undelivered message(s)"
@@ -457,6 +482,7 @@ pub_sub:
                 - resource.label.subscription_id
     documentation:
       subject: 'Subscription: `$${resource.label.subscription_id}`'
+      content: 'Review the subscription in Pub/Sub: https://console.cloud.google.com/cloudpubsub/subscriptions?project=<%-projectId%>'
   messages_in_dlq:
     display_name: "[P3] <%-clan%> - Pub/Sub | Message(s) in DLQ"
     conditions:
@@ -477,6 +503,7 @@ pub_sub:
                 - metric.label.response_code
     documentation:
       subject: 'Subscription: `$${resource.label.subscription_id}`, Response code: `$${metric.label.response_code}`'
+      content: 'Review the subscription in Pub/Sub: https://console.cloud.google.com/cloudpubsub/subscriptions?project=<%-projectId%>'
   latency:
     display_name: "[P3] <%-clan%> - Pub/Sub | Response latency distribution"
     conditions:
@@ -496,6 +523,7 @@ pub_sub:
                 - resource.label.subscription_id
     documentation:
       subject: 'Subscription: `$${resource.label.subscription_id}`'
+      content: 'Review the subscription in Pub/Sub: https://console.cloud.google.com/cloudpubsub/subscriptions?project=<%-projectId%>'
   oldest_unacked_message_age:
     display_name: "[P3] <%-clan%> - Pub/Sub | Oldest unacked message age"
     conditions:
@@ -514,6 +542,7 @@ pub_sub:
                 - resource.label.subscription_id
     documentation:
       subject: 'Subscription: `$${resource.label.subscription_id}`'
+      content: 'Review the subscription in Pub/Sub: https://console.cloud.google.com/cloudpubsub/subscriptions?project=<%-projectId%>'
   push_requests_ack:
     display_name: "[P3] <%-clan%> - Pub/Sub | Push requests ack"
     conditions:
@@ -533,6 +562,7 @@ pub_sub:
                 - resource.label.subscription_id
     documentation:
       subject: 'Subscription: `$${resource.label.subscription_id}`'
+      content: 'Review the subscription in Pub/Sub: https://console.cloud.google.com/cloudpubsub/subscriptions?project=<%-projectId%>'
   push_requests_success:
     display_name: "[P3] <%-clan%> - Pub/Sub | Push requests success"
     conditions:
@@ -552,6 +582,7 @@ pub_sub:
                 - resource.label.subscription_id
     documentation:
       subject: 'Subscription: `$${resource.label.subscription_id}`'
+      content: 'Review the subscription in Pub/Sub: https://console.cloud.google.com/cloudpubsub/subscriptions?project=<%-projectId%>'
   delivery_latency_health_score:
     display_name: "[P3] <%-clan%> - Pub/Sub | Delivery latency health score"
     conditions:
@@ -571,6 +602,7 @@ pub_sub:
                 - resource.label.subscription_id
     documentation:
       subject: 'Subscription: `$${resource.label.subscription_id}`'
+      content: 'Review the subscription in Pub/Sub: https://console.cloud.google.com/cloudpubsub/subscriptions?project=<%-projectId%>'
 spanner:
   cpu_utilization_by_priority:
     display_name: "[P2] <%-clan%> - Spanner | CPU Utilization"
@@ -591,6 +623,7 @@ spanner:
                 - metric.label.database
     documentation:
       subject: 'Instance: `$${resource.label.instance_id}`, Database: `$${resource.label.database}`'
+      content: 'Review the instance in Spanner: https://console.cloud.google.com/spanner/instances?project=<%-projectId%>'
   api_request_error_rate:
     display_name: "[P2] <%-clan%> - Spanner | API request error rate"
     conditions:
@@ -611,6 +644,7 @@ spanner:
                 - resource.label.database
     documentation:
       subject: 'Instance: `$${resource.label.instance_id}`, Database: `$${resource.label.database}`'
+      content: 'Review the instance in Spanner: https://console.cloud.google.com/spanner/instances?project=<%-projectId%>'
   request_latencies:
     display_name: '[P3] <%-clan%> - Spanner | API transaction latency'
     conditions:
@@ -631,3 +665,4 @@ spanner:
               per_series_aligner: ALIGN_PERCENTILE_95
     documentation:
       subject: 'Instance: `$${resource.label.instance_id}`, Database: `$${resource.label.database}}`'
+      content: 'Review the instance in Spanner: https://console.cloud.google.com/spanner/instances?project=<%-projectId%>'

package/dist/node_modules/.package-lock.json

@@ -563,9 +563,9 @@
       "license": "MIT"
     },
     "node_modules/@esbuild/linux-x64": {
-      "version": "0.25.8",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.8.tgz",
-      "integrity": "sha512-ASFQhgY4ElXh3nDcOMTkQero4b1lgubskNlhIfJrsH5OKZXDpUAKBlNS0Kx81jwOBp+HCeZqmoJuihTv57/jvQ==",
+      "version": "0.25.9",
+      "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.9.tgz",
+      "integrity": "sha512-iSwByxzRe48YVkmpbgoxVzn76BXjlYFXC7NvLYq+b+kDjyyk30J0JY47DIn8z1MO3K0oSl9fZoRmZPQI4Hklzg==",
       "cpu": [
         "x64"
       ],
@@ -775,10 +775,9 @@
       }
     },
     "node_modules/@google-cloud/storage": {
-      "version": "7.16.0",
-      "resolved": "https://registry.npmjs.org/@google-cloud/storage/-/storage-7.16.0.tgz",
-      "integrity": "sha512-7/5LRgykyOfQENcm6hDKP8SX/u9XxE5YOiWOkgkwcoO+cG8xT/cyOvp9wwN3IxfdYgpHs8CE7Nq2PKX2lNaEXw==",
-      "license": "Apache-2.0",
+      "version": "7.17.0",
+      "resolved": "https://registry.npmjs.org/@google-cloud/storage/-/storage-7.17.0.tgz",
+      "integrity": "sha512-5m9GoZqKh52a1UqkxDBu/+WVFDALNtHg5up5gNmNbXQWBcV813tzJKsyDtKjOPrlR1em1TxtD7NSPCrObH7koQ==",
       "dependencies": {
         "@google-cloud/paginator": "^5.0.0",
         "@google-cloud/projectify": "^4.0.0",
@@ -3894,9 +3893,9 @@
       }
     },
     "node_modules/esbuild": {
-      "version": "0.25.8",
-      "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.8.tgz",
-      "integrity": "sha512-vVC0USHGtMi8+R4Kz8rt6JhEWLxsv9Rnu/lGYbPR8u47B+DCBksq9JarW0zOO7bs37hyOK1l2/oqtbciutL5+Q==",
+      "version": "0.25.9",
+      "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.9.tgz",
+      "integrity": "sha512-CRbODhYyQx3qp7ZEwzxOk4JBqmD/seJrzPa/cGjY1VtIn5E09Oi9/dB4JwctnfZ8Q8iT7rioVv5k/FNT/uf54g==",
       "dev": true,
       "hasInstallScript": true,
       "license": "MIT",
@@ -3907,32 +3906,32 @@
         "node": ">=18"
       },
       "optionalDependencies": {
-        "@esbuild/aix-ppc64": "0.25.8",
-        "@esbuild/android-arm": "0.25.8",
-        "@esbuild/android-arm64": "0.25.8",
-        "@esbuild/android-x64": "0.25.8",
-        "@esbuild/darwin-arm64": "0.25.8",
-        "@esbuild/darwin-x64": "0.25.8",
-        "@esbuild/freebsd-arm64": "0.25.8",
-        "@esbuild/freebsd-x64": "0.25.8",
-        "@esbuild/linux-arm": "0.25.8",
-        "@esbuild/linux-arm64": "0.25.8",
-        "@esbuild/linux-ia32": "0.25.8",
-        "@esbuild/linux-loong64": "0.25.8",
-        "@esbuild/linux-mips64el": "0.25.8",
-        "@esbuild/linux-ppc64": "0.25.8",
-        "@esbuild/linux-riscv64": "0.25.8",
-        "@esbuild/linux-s390x": "0.25.8",
-        "@esbuild/linux-x64": "0.25.8",
-        "@esbuild/netbsd-arm64": "0.25.8",
-        "@esbuild/netbsd-x64": "0.25.8",
-        "@esbuild/openbsd-arm64": "0.25.8",
-        "@esbuild/openbsd-x64": "0.25.8",
-        "@esbuild/openharmony-arm64": "0.25.8",
-        "@esbuild/sunos-x64": "0.25.8",
-        "@esbuild/win32-arm64": "0.25.8",
-        "@esbuild/win32-ia32": "0.25.8",
-        "@esbuild/win32-x64": "0.25.8"
+        "@esbuild/aix-ppc64": "0.25.9",
+        "@esbuild/android-arm": "0.25.9",
+        "@esbuild/android-arm64": "0.25.9",
+        "@esbuild/android-x64": "0.25.9",
+        "@esbuild/darwin-arm64": "0.25.9",
+        "@esbuild/darwin-x64": "0.25.9",
+        "@esbuild/freebsd-arm64": "0.25.9",
+        "@esbuild/freebsd-x64": "0.25.9",
+        "@esbuild/linux-arm": "0.25.9",
+        "@esbuild/linux-arm64": "0.25.9",
+        "@esbuild/linux-ia32": "0.25.9",
+        "@esbuild/linux-loong64": "0.25.9",
+        "@esbuild/linux-mips64el": "0.25.9",
+        "@esbuild/linux-ppc64": "0.25.9",
+        "@esbuild/linux-riscv64": "0.25.9",
+        "@esbuild/linux-s390x": "0.25.9",
+        "@esbuild/linux-x64": "0.25.9",
+        "@esbuild/netbsd-arm64": "0.25.9",
+        "@esbuild/netbsd-x64": "0.25.9",
+        "@esbuild/openbsd-arm64": "0.25.9",
+        "@esbuild/openbsd-x64": "0.25.9",
+        "@esbuild/openharmony-arm64": "0.25.9",
+        "@esbuild/sunos-x64": "0.25.9",
+        "@esbuild/win32-arm64": "0.25.9",
+        "@esbuild/win32-ia32": "0.25.9",
+        "@esbuild/win32-x64": "0.25.9"
       }
     },
     "node_modules/escalade": {
@@ -8285,9 +8284,9 @@
       "integrity": "sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ=="
     },
     "node_modules/nock": {
-      "version": "14.0.9",
-      "resolved": "https://registry.npmjs.org/nock/-/nock-14.0.9.tgz",
-      "integrity": "sha512-aVIPgW9WVyb3XPCqfrwETc+hazxzgt8/QvARHAhC6BYHtTsZONUjlXoIB8EGmwqUBkKvOew4yqkGRBmwctdCrw==",
+      "version": "14.0.10",
+      "resolved": "https://registry.npmjs.org/nock/-/nock-14.0.10.tgz",
+      "integrity": "sha512-Q7HjkpyPeLa0ZVZC5qpxBt5EyLczFJ91MEewQiIi9taWuA0KB/MDJlUWtON+7dGouVdADTQsf9RA7TZk6D8VMw==",
       "dev": true,
       "license": "MIT",
       "dependencies": {
@@ -11543,10 +11542,10 @@
     },
     "packages/generators": {
       "name": "@hiiretail/gcp-infra-generators",
-      "version": "1.0.1",
+      "version": "1.0.2",
       "license": "MIT",
       "dependencies": {
-        "@google-cloud/storage": "^7.16.0",
+        "@google-cloud/storage": "^7.17.0",
         "axios": "^1.11.0",
         "chalk": "^4.1.2",
         "commander": "^14.0.0",

package/dist/node_modules/@google-cloud/storage/build/cjs/src/bucket.js

@@ -821,7 +821,7 @@ class Bucket extends index_js_1.ServiceObject {
      *     **Note**: For configuring a raw-formatted rule object to be passed as `action`
      *               please refer to the [examples]{@link https://cloud.google.com/storage/docs/managing-lifecycles#configexamples}.
      * @param {object} rule.condition Condition a bucket must meet before the
-     *     action occurson the bucket. Refer to followitn supported [conditions]{@link https://cloud.google.com/storage/docs/lifecycle#conditions}.
+     *     action occurs on the bucket. Refer to following supported [conditions]{@link https://cloud.google.com/storage/docs/lifecycle#conditions}.
      * @param {string} [rule.storageClass] When using the `setStorageClass`
      *     action, provide this option to dictate which storage class the object
      *     should update to.
@@ -1347,7 +1347,7 @@ class Bucket extends index_js_1.ServiceObject {
      * myBucket.createNotification('my-topic', callback);
      *
      * //-
-     * // Configure the nofiication by providing Notification metadata.
+     * // Configure the notification by providing Notification metadata.
      * //-
      * const metadata = {
      *   objectNamePrefix: 'prefix-'
@@ -2304,7 +2304,7 @@ class Bucket extends index_js_1.ServiceObject {
      * @property {boolean} [virtualHostedStyle=false] Use virtual hosted-style
      *     URLs ('https://mybucket.storage.googleapis.com/...') instead of path-style
      *     ('https://storage.googleapis.com/mybucket/...'). Virtual hosted-style URLs
-     *     should generally be preferred instaed of path-style URL.
+     *     should generally be preferred instead of path-style URL.
      *     Currently defaults to `false` for path-style, although this may change in a
      *     future major-version release.
      * @property {string} [cname] The cname for this bucket, i.e.,
@@ -2351,7 +2351,7 @@ class Bucket extends index_js_1.ServiceObject {
      * @param {boolean} [config.virtualHostedStyle=false] Use virtual hosted-style
      *     URLs ('https://mybucket.storage.googleapis.com/...') instead of path-style
      *     ('https://storage.googleapis.com/mybucket/...'). Virtual hosted-style URLs
-     *     should generally be preferred instaed of path-style URL.
+     *     should generally be preferred instead of path-style URL.
      *     Currently defaults to `false` for path-style, although this may change in a
      *     future major-version release.
      * @param {string} [config.cname] The cname for this bucket, i.e.,
@@ -2441,7 +2441,7 @@ class Bucket extends index_js_1.ServiceObject {
      * @throws {Error} if a metageneration is not provided.
      *
      * @param {number|string} metageneration The bucket's metageneration. This is
-     *     accesssible from calling {@link File#getMetadata}.
+     *     accessible from calling {@link File#getMetadata}.
      * @param {BucketLockCallback} [callback] Callback function.
      * @returns {Promise<BucketLockResponse>}
      *

package/dist/node_modules/@google-cloud/storage/build/cjs/src/file.d.ts

@@ -217,6 +217,7 @@ export type DownloadResponse = [Buffer];
 export type DownloadCallback = (err: RequestError | null, contents: Buffer) => void;
 export interface DownloadOptions extends CreateReadStreamOptions {
     destination?: string;
+    encryptionKey?: string | Buffer;
 }
 export interface CreateReadStreamOptions {
     userProject?: string;

package/dist/node_modules/@google-cloud/storage/build/cjs/src/file.js

@@ -1507,6 +1507,9 @@ class File extends index_js_1.ServiceObject {
             transformStreams.push(zlib.createGzip());
         }
         const emitStream = new util_js_2.PassThroughShim();
+        // If `writeStream` is destroyed before the `writing` event, `emitStream` will not have any listeners. This prevents an unhandled error.
+        const noop = () => { };
+        emitStream.on('error', noop);
         let hashCalculatingStream = null;
         if (crc32c || md5) {
             const crc32cInstance = options.resumeCRC32C
@@ -1539,6 +1542,8 @@ class File extends index_js_1.ServiceObject {
             else {
                 this.startResumableUpload_(fileWriteStream, options);
             }
+            // remove temporary noop listener as we now create a pipeline that handles the errors
+            emitStream.removeListener('error', noop);
             (0, stream_1.pipeline)(emitStream, ...transformStreams, fileWriteStream, async (e) => {
                 if (e) {
                     return pipelineCallback(e);
@@ -1673,6 +1678,10 @@ class File extends index_js_1.ServiceObject {
         });
         const destination = options.destination;
         delete options.destination;
+        if (options.encryptionKey) {
+            this.setEncryptionKey(options.encryptionKey);
+            delete options.encryptionKey;
+        }
         const fileStream = this.createReadStream(options);
         let receivedData = false;
         if (destination) {
@@ -2226,7 +2235,7 @@ class File extends index_js_1.ServiceObject {
      * @param {boolean} [config.virtualHostedStyle=false] Use virtual hosted-style
      *     URLs (e.g. 'https://mybucket.storage.googleapis.com/...') instead of path-style
      *     (e.g. 'https://storage.googleapis.com/mybucket/...'). Virtual hosted-style URLs
-     *     should generally be preferred instaed of path-style URL.
+     *     should generally be preferred instead of path-style URL.
      *     Currently defaults to `false` for path-style, although this may change in a
      *     future major-version release.
      * @param {string} [config.cname] The cname for this bucket, i.e.,

package/dist/node_modules/@google-cloud/storage/build/cjs/src/storage.js

@@ -599,7 +599,7 @@ class Storage extends index_js_1.Service {
      *     For more information, see {@link https://cloud.google.com/storage/docs/locations| Bucket Locations}.
      * @property {boolean} [dra=false] Specify the storage class as Durable Reduced
      *     Availability.
-     * @property {boolean} [enableObjectRetention=false] Specifiy whether or not object retention should be enabled on this bucket.
+     * @property {boolean} [enableObjectRetention=false] Specify whether or not object retention should be enabled on this bucket.
      * @property {object} [hierarchicalNamespace.enabled=false] Specify whether or not to enable hierarchical namespace on this bucket.
      * @property {string} [location] Specify the bucket's location. If specifying
      *     a dual-region, the `customPlacementConfig` property should be set in conjunction.

package/dist/node_modules/@google-cloud/storage/build/cjs/src/transfer-manager.d.ts

@@ -84,7 +84,7 @@ export declare class TransferManager {
      * @typedef {object} UploadManyFilesOptions
      * @property {number} [concurrencyLimit] The number of concurrently executing promises
      * to use when uploading the files.
-     * @property {Function} [customDestinationBuilder] A fuction that will take the current path of a local file
+     * @property {Function} [customDestinationBuilder] A function that will take the current path of a local file
      * and return a string representing a custom path to be used to upload the file to GCS.
      * @property {boolean} [skipIfExists] Do not upload the file if it already exists in
      * the bucket. This will set the precondition ifGenerationMatch = 0.
@@ -209,7 +209,7 @@ export declare class TransferManager {
      * @property {number} [concurrencyLimit] The number of concurrently executing promises
      * to use when uploading the file.
      * @property {number} [chunkSizeBytes] The size in bytes of each chunk to be uploaded.
-     * @property {string} [uploadName] Name of the file when saving to GCS. If ommitted the name is taken from the file path.
+     * @property {string} [uploadName] Name of the file when saving to GCS. If omitted the name is taken from the file path.
      * @property {number} [maxQueueSize] The number of chunks to be uploaded to hold in memory concurrently. If not specified
      * defaults to the specified concurrency limit.
      * @property {string} [uploadId] If specified attempts to resume a previous upload.
@@ -222,14 +222,14 @@ export declare class TransferManager {
      *
      */
     /**
-     * Upload a large file in chunks utilizing parallel upload opertions. If the upload fails, an uploadId and
+     * Upload a large file in chunks utilizing parallel upload operations. If the upload fails, an uploadId and
      * map containing all the successfully uploaded parts will be returned to the caller. These arguments can be used to
      * resume the upload.
      *
      * @param {string} [filePath] The path of the file to be uploaded
      * @param {UploadFileInChunksOptions} [options] Configuration options.
      * @param {MultiPartHelperGenerator} [generator] A function that will return a type that implements the MPU interface. Most users will not need to use this.
-     * @returns {Promise<void>} If successful a promise resolving to void, otherwise a error containing the message, uploadid, and parts map.
+     * @returns {Promise<void>} If successful a promise resolving to void, otherwise a error containing the message, uploadId, and parts map.
      *
      * @example
      * ```

package/dist/node_modules/@google-cloud/storage/build/cjs/src/transfer-manager.js

@@ -326,7 +326,7 @@ class TransferManager {
      * @typedef {object} UploadManyFilesOptions
      * @property {number} [concurrencyLimit] The number of concurrently executing promises
      * to use when uploading the files.
-     * @property {Function} [customDestinationBuilder] A fuction that will take the current path of a local file
+     * @property {Function} [customDestinationBuilder] A function that will take the current path of a local file
      * and return a string representing a custom path to be used to upload the file to GCS.
      * @property {boolean} [skipIfExists] Do not upload the file if it already exists in
      * the bucket. This will set the precondition ifGenerationMatch = 0.
@@ -595,7 +595,7 @@ class TransferManager {
      * @property {number} [concurrencyLimit] The number of concurrently executing promises
      * to use when uploading the file.
      * @property {number} [chunkSizeBytes] The size in bytes of each chunk to be uploaded.
-     * @property {string} [uploadName] Name of the file when saving to GCS. If ommitted the name is taken from the file path.
+     * @property {string} [uploadName] Name of the file when saving to GCS. If omitted the name is taken from the file path.
      * @property {number} [maxQueueSize] The number of chunks to be uploaded to hold in memory concurrently. If not specified
      * defaults to the specified concurrency limit.
      * @property {string} [uploadId] If specified attempts to resume a previous upload.
@@ -608,14 +608,14 @@ class TransferManager {
      *
      */
     /**
-     * Upload a large file in chunks utilizing parallel upload opertions. If the upload fails, an uploadId and
+     * Upload a large file in chunks utilizing parallel upload operations. If the upload fails, an uploadId and
      * map containing all the successfully uploaded parts will be returned to the caller. These arguments can be used to
      * resume the upload.
      *
      * @param {string} [filePath] The path of the file to be uploaded
      * @param {UploadFileInChunksOptions} [options] Configuration options.
      * @param {MultiPartHelperGenerator} [generator] A function that will return a type that implements the MPU interface. Most users will not need to use this.
-     * @returns {Promise<void>} If successful a promise resolving to void, otherwise a error containing the message, uploadid, and parts map.
+     * @returns {Promise<void>} If successful a promise resolving to void, otherwise a error containing the message, uploadId, and parts map.
      *
      * @example
      * ```

package/dist/node_modules/@google-cloud/storage/build/cjs/src/util.d.ts

@@ -61,7 +61,7 @@ export declare function convertObjKeysToSnakeCase(obj: object): object;
  * @param {boolean} includeTime flag to include hours, minutes, seconds in output.
  * @param {string} dateDelimiter delimiter between date components.
  * @param {string} timeDelimiter delimiter between time components.
- * @returns {string} UTC ISO format of provided date obect.
+ * @returns {string} UTC ISO format of provided date object.
  */
 export declare function formatAsUTCISO(dateTimeToFormat: Date, includeTime?: boolean, dateDelimiter?: string, timeDelimiter?: string): string;
 /**

package/dist/node_modules/@google-cloud/storage/build/cjs/src/util.js

@@ -179,7 +179,7 @@ function convertObjKeysToSnakeCase(obj) {
  * @param {boolean} includeTime flag to include hours, minutes, seconds in output.
  * @param {string} dateDelimiter delimiter between date components.
  * @param {string} timeDelimiter delimiter between time components.
- * @returns {string} UTC ISO format of provided date obect.
+ * @returns {string} UTC ISO format of provided date object.
  */
 function formatAsUTCISO(dateTimeToFormat, includeTime = false, dateDelimiter = '', timeDelimiter = '') {
   const year = dateTimeToFormat.getUTCFullYear();
@@ -258,7 +258,7 @@ class PassThroughShim extends stream_1.PassThrough {
       this.emit('writing');
       this.shouldEmitWriting = false;
     }
-    // Per the nodejs documention, callback must be invoked on the next tick
+    // Per the nodejs documentation, callback must be invoked on the next tick
     process.nextTick(() => {
       super._write(chunk, encoding, callback);
     });

package/dist/node_modules/@google-cloud/storage/build/esm/src/bucket.js

@@ -782,7 +782,7 @@ class Bucket extends ServiceObject {
      *     **Note**: For configuring a raw-formatted rule object to be passed as `action`
      *               please refer to the [examples]{@link https://cloud.google.com/storage/docs/managing-lifecycles#configexamples}.
      * @param {object} rule.condition Condition a bucket must meet before the
-     *     action occurson the bucket. Refer to followitn supported [conditions]{@link https://cloud.google.com/storage/docs/lifecycle#conditions}.
+     *     action occurs on the bucket. Refer to following supported [conditions]{@link https://cloud.google.com/storage/docs/lifecycle#conditions}.
      * @param {string} [rule.storageClass] When using the `setStorageClass`
      *     action, provide this option to dictate which storage class the object
      *     should update to.
@@ -1308,7 +1308,7 @@ class Bucket extends ServiceObject {
      * myBucket.createNotification('my-topic', callback);
      *
      * //-
-     * // Configure the nofiication by providing Notification metadata.
+     * // Configure the notification by providing Notification metadata.
      * //-
      * const metadata = {
      *   objectNamePrefix: 'prefix-'
@@ -2265,7 +2265,7 @@ class Bucket extends ServiceObject {
      * @property {boolean} [virtualHostedStyle=false] Use virtual hosted-style
      *     URLs ('https://mybucket.storage.googleapis.com/...') instead of path-style
      *     ('https://storage.googleapis.com/mybucket/...'). Virtual hosted-style URLs
-     *     should generally be preferred instaed of path-style URL.
+     *     should generally be preferred instead of path-style URL.
      *     Currently defaults to `false` for path-style, although this may change in a
      *     future major-version release.
      * @property {string} [cname] The cname for this bucket, i.e.,
@@ -2312,7 +2312,7 @@ class Bucket extends ServiceObject {
      * @param {boolean} [config.virtualHostedStyle=false] Use virtual hosted-style
      *     URLs ('https://mybucket.storage.googleapis.com/...') instead of path-style
      *     ('https://storage.googleapis.com/mybucket/...'). Virtual hosted-style URLs
-     *     should generally be preferred instaed of path-style URL.
+     *     should generally be preferred instead of path-style URL.
      *     Currently defaults to `false` for path-style, although this may change in a
      *     future major-version release.
      * @param {string} [config.cname] The cname for this bucket, i.e.,
@@ -2402,7 +2402,7 @@ class Bucket extends ServiceObject {
      * @throws {Error} if a metageneration is not provided.
      *
      * @param {number|string} metageneration The bucket's metageneration. This is
-     *     accesssible from calling {@link File#getMetadata}.
+     *     accessible from calling {@link File#getMetadata}.
      * @param {BucketLockCallback} [callback] Callback function.
      * @returns {Promise<BucketLockResponse>}
      *