messages.ts

// Copyright 2018 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

export enum WarningTypes {
  WARNING = 'Warning',
  DEPRECATION = 'DeprecationWarning',
}

export function warn(warning: Warning) {
  // Only show a given warning once
  if (warning.warned) {
    return;
  }
  warning.warned = true;
  if (typeof process !== 'undefined' && process.emitWarning) {
    // @types/node doesn't recognize the emitWarning syntax which
    // accepts a config object, so `as any` it is
    // https://nodejs.org/docs/latest-v8.x/api/process.html#process_process_emitwarning_warning_options
    // tslint:disable-next-line no-any
    process.emitWarning(warning.message, warning as any);
  } else {
    console.warn(warning.message);
  }
}

export interface Warning {
  code: string;
  type: WarningTypes;
  message: string;
  warned?: boolean;
}

export const DEFAULT_PROJECT_ID_DEPRECATED = {
  code: 'google-auth-library:DEP002',
  type: WarningTypes.DEPRECATION,
  message: [
    'The `getDefaultProjectId` method has been deprecated, and will be removed',
    'in the 3.0 release of google-auth-library. Please use the `getProjectId`',
    'method instead.',
  ].join(' '),
};

export const COMPUTE_CREATE_SCOPED_DEPRECATED = {
  code: 'google-auth-library:DEP003',
  type: WarningTypes.DEPRECATION,
  message: [
    'The `createScopedRequired` method on the `Compute` class has been deprecated,',
    'and will be removed in the 3.0 release of google-auth-library.',
  ].join(' '),
};

export const JWT_CREATE_SCOPED_DEPRECATED = {
  code: 'google-auth-library:DEP004',
  type: WarningTypes.DEPRECATION,
  message: [
    'The `createScopedRequired` method on the `JWT` class has been deprecated,',
    'and will be removed in the 3.0 release of google-auth-library.',
  ].join(' '),
};

export const IAM_CREATE_SCOPED_DEPRECATED = {
  code: 'google-auth-library:DEP005',
  type: WarningTypes.DEPRECATION,
  message: [
    'The `createScopedRequired` method on the `IAM` class has been deprecated,',
    'and will be removed in the 3.0 release of google-auth-library.',
  ].join(' '),
};

export const JWT_ACCESS_CREATE_SCOPED_DEPRECATED = {
  code: 'google-auth-library:DEP006',
  type: WarningTypes.DEPRECATION,
  message: [
    'The `createScopedRequired` method on the `JWTAccess` class has been deprecated,',
    'and will be removed in the 3.0 release of google-auth-library.',
  ].join(' '),
};

export const OAUTH_GET_REQUEST_METADATA_DEPRECATED = {
  code: 'google-auth-library:DEP004',
  type: WarningTypes.DEPRECATION,
  message: [
    'The `getRequestMetadata` method on the `OAuth2` class has been deprecated,',
    'and will be removed in the 3.0 release of google-auth-library. Please use',
    'the `getRequestHeaders` method instead.',
  ].join(' '),
};

export const IAM_GET_REQUEST_METADATA_DEPRECATED = {
  code: 'google-auth-library:DEP005',
  type: WarningTypes.DEPRECATION,
  message: [
    'The `getRequestMetadata` method on the `IAM` class has been deprecated,',
    'and will be removed in the 3.0 release of google-auth-library. Please use',
    'the `getRequestHeaders` method instead.',
  ].join(' '),
};

export const JWT_ACCESS_GET_REQUEST_METADATA_DEPRECATED = {
  code: 'google-auth-library:DEP006',
  type: WarningTypes.DEPRECATION,
  message: [
    'The `getRequestMetadata` method on the `JWTAccess` class has been deprecated,',
    'and will be removed in the 3.0 release of google-auth-library. Please use',
    'the `getRequestHeaders` method instead.',
  ].join(' '),
};