feat!: better typing for metadata (#2234)

* test: cleanup kms tests to avoid setting incorrect keys (#2213) * chore(deps): update dependency c8 to v8 (#2221) * feat!: better typing for metadata * more metadata typing * fix merge problems * remove extend * fix merge conflicts --------- Co-authored-by: Mend Renovate <[email protected]>
googleapis · Jul 24, 2023 · ee8354e · ee8354e
1 parent e24b099
commit ee8354e
Show file tree

Hide file tree

Showing 23 changed files with 818 additions and 676 deletions.
diff --git a/conformance-test/libraryMethods.ts b/conformance-test/libraryMethods.ts
@@ -110,7 +110,7 @@ export async function combine(options: ConformanceTestOptions) {
   await allFiles.save('allfiles contents');
   if (options.preconditionRequired) {
     await options.bucket!.combine(sources, allFiles, {
-      ifGenerationMatch: allFiles.metadata.generation,
+      ifGenerationMatch: allFiles.metadata.generation!,
     });
   } else {
     await options.bucket!.combine(sources, allFiles);
@@ -474,7 +474,9 @@ export async function copy(options: ConformanceTestOptions) {
 
   if (options.preconditionRequired) {
     await options.file!.copy('a-different-file.png', {
-      preconditionOpts: {ifGenerationMatch: newFile.metadata.generation},
+      preconditionOpts: {
+        ifGenerationMatch: newFile.metadata.generation!,
+      },
     });
   } else {
     await options.file!.copy('a-different-file.png');

diff --git a/package.json b/package.json
@@ -58,7 +58,7 @@
     "compressible": "^2.0.12",
     "duplexify": "^4.0.0",
     "ent": "^2.2.0",
-    "gaxios": "^5.0.0",
+    "gaxios": "^5.1.2",
     "google-auth-library": "^8.0.1",
     "mime": "^3.0.0",
     "mime-types": "^2.0.8",
@@ -86,7 +86,7 @@
     "@types/tmp": "0.2.3",
     "@types/uuid": "^8.0.0",
     "@types/yargs": "^17.0.10",
-    "c8": "^7.0.0",
+    "c8": "^8.0.0",
     "form-data": "^4.0.0",
     "gts": "^3.1.0",
     "jsdoc": "^4.0.0",

diff --git a/src/acl.ts b/src/acl.ts
@@ -15,7 +15,7 @@
 import {
   BodyResponseCallback,
   DecorateRequestOptions,
-  Metadata,
+  BaseMetadata,
 } from './nodejs-common';
 import {promisifyAll} from '@google-cloud/promisify';
 
@@ -29,13 +29,13 @@ export interface AclOptions {
 
 export type GetAclResponse = [
   AccessControlObject | AccessControlObject[],
-  Metadata
+  AclMetadata
 ];
 export interface GetAclCallback {
   (
     err: Error | null,
     acl?: AccessControlObject | AccessControlObject[] | null,
-    apiResponse?: Metadata
+    apiResponse?: AclMetadata
   ): void;
 }
 export interface GetAclOptions {
@@ -50,12 +50,12 @@ export interface UpdateAclOptions {
   generation?: number;
   userProject?: string;
 }
-export type UpdateAclResponse = [AccessControlObject, Metadata];
+export type UpdateAclResponse = [AccessControlObject, AclMetadata];
 export interface UpdateAclCallback {
   (
     err: Error | null,
     acl?: AccessControlObject | null,
-    apiResponse?: Metadata
+    apiResponse?: AclMetadata
   ): void;
 }
 
@@ -65,17 +65,17 @@ export interface AddAclOptions {
   generation?: number;
   userProject?: string;
 }
-export type AddAclResponse = [AccessControlObject, Metadata];
+export type AddAclResponse = [AccessControlObject, AclMetadata];
 export interface AddAclCallback {
   (
     err: Error | null,
     acl?: AccessControlObject | null,
-    apiResponse?: Metadata
+    apiResponse?: AclMetadata
   ): void;
 }
-export type RemoveAclResponse = [Metadata];
+export type RemoveAclResponse = [AclMetadata];
 export interface RemoveAclCallback {
-  (err: Error | null, apiResponse?: Metadata): void;
+  (err: Error | null, apiResponse?: AclMetadata): void;
 }
 export interface RemoveAclOptions {
   entity: string;
@@ -94,6 +94,21 @@ export interface AccessControlObject {
   projectTeam: string;
 }
 
+export interface AclMetadata extends BaseMetadata {
+  bucket?: string;
+  domain?: string;
+  entity?: string;
+  entityId?: string;
+  generation?: string;
+  object?: string;
+  projectTeam?: {
+    projectNumber?: string;
+    team?: 'editors' | 'owners' | 'viewers';
+  };
+  role?: 'OWNER' | 'READER' | 'WRITER' | 'FULL_CONTROL';
+  [key: string]: unknown;
+}
+
 /**
  * Attach functionality to a {@link Storage.acl} instance. This will add an
  * object for each role group (owners, readers, and writers), with each object