firebase-admin 11.10.1 → 11.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/app/core.d.ts +1 -1
- package/lib/app/core.js +1 -1
- package/lib/app/credential-factory.d.ts +1 -1
- package/lib/app/credential-factory.js +1 -1
- package/lib/app/credential-internal.d.ts +1 -1
- package/lib/app/credential-internal.js +1 -1
- package/lib/app/credential.d.ts +1 -1
- package/lib/app/credential.js +1 -1
- package/lib/app/firebase-app.d.ts +1 -1
- package/lib/app/firebase-app.js +1 -1
- package/lib/app/firebase-namespace.d.ts +1 -1
- package/lib/app/firebase-namespace.js +1 -1
- package/lib/app/index.d.ts +1 -1
- package/lib/app/index.js +1 -1
- package/lib/app/lifecycle.d.ts +1 -1
- package/lib/app/lifecycle.js +1 -1
- package/lib/app-check/app-check-api-client-internal.d.ts +1 -1
- package/lib/app-check/app-check-api-client-internal.js +1 -1
- package/lib/app-check/app-check-api.d.ts +1 -1
- package/lib/app-check/app-check-api.js +1 -1
- package/lib/app-check/app-check-namespace.d.ts +1 -1
- package/lib/app-check/app-check-namespace.js +1 -1
- package/lib/app-check/app-check.d.ts +1 -1
- package/lib/app-check/app-check.js +1 -1
- package/lib/app-check/index.d.ts +1 -1
- package/lib/app-check/index.js +1 -1
- package/lib/app-check/token-generator.d.ts +1 -1
- package/lib/app-check/token-generator.js +1 -1
- package/lib/app-check/token-verifier.d.ts +1 -1
- package/lib/app-check/token-verifier.js +1 -1
- package/lib/auth/action-code-settings-builder.d.ts +1 -1
- package/lib/auth/action-code-settings-builder.js +1 -1
- package/lib/auth/auth-api-request.d.ts +1 -1
- package/lib/auth/auth-api-request.js +1 -1
- package/lib/auth/auth-config.d.ts +10 -1
- package/lib/auth/auth-config.js +27 -2
- package/lib/auth/auth-namespace.d.ts +1 -1
- package/lib/auth/auth-namespace.js +1 -1
- package/lib/auth/auth.d.ts +1 -1
- package/lib/auth/auth.js +1 -1
- package/lib/auth/base-auth.d.ts +1 -1
- package/lib/auth/base-auth.js +1 -1
- package/lib/auth/identifier.d.ts +1 -1
- package/lib/auth/identifier.js +1 -1
- package/lib/auth/index.d.ts +2 -2
- package/lib/auth/index.js +1 -1
- package/lib/auth/project-config-manager.d.ts +1 -1
- package/lib/auth/project-config-manager.js +1 -1
- package/lib/auth/project-config.d.ts +16 -6
- package/lib/auth/project-config.js +16 -1
- package/lib/auth/tenant-manager.d.ts +1 -1
- package/lib/auth/tenant-manager.js +1 -1
- package/lib/auth/tenant.d.ts +12 -2
- package/lib/auth/tenant.js +16 -1
- package/lib/auth/token-generator.d.ts +1 -1
- package/lib/auth/token-generator.js +1 -1
- package/lib/auth/token-verifier.d.ts +1 -1
- package/lib/auth/token-verifier.js +1 -1
- package/lib/auth/user-import-builder.d.ts +1 -1
- package/lib/auth/user-import-builder.js +1 -1
- package/lib/auth/user-record.d.ts +1 -1
- package/lib/auth/user-record.js +1 -1
- package/lib/credential/index.d.ts +1 -1
- package/lib/credential/index.js +1 -1
- package/lib/database/database-namespace.d.ts +1 -1
- package/lib/database/database-namespace.js +1 -1
- package/lib/database/database.d.ts +1 -1
- package/lib/database/database.js +1 -1
- package/lib/database/index.d.ts +1 -1
- package/lib/database/index.js +1 -1
- package/lib/default-namespace.d.ts +1 -1
- package/lib/default-namespace.js +1 -1
- package/lib/eventarc/cloudevent.d.ts +1 -1
- package/lib/eventarc/cloudevent.js +1 -1
- package/lib/eventarc/eventarc-client-internal.d.ts +1 -1
- package/lib/eventarc/eventarc-client-internal.js +1 -1
- package/lib/eventarc/eventarc-utils.d.ts +1 -1
- package/lib/eventarc/eventarc-utils.js +1 -1
- package/lib/eventarc/eventarc.d.ts +1 -1
- package/lib/eventarc/eventarc.js +1 -1
- package/lib/eventarc/index.d.ts +1 -1
- package/lib/eventarc/index.js +1 -1
- package/lib/extensions/extensions-api-client-internal.d.ts +1 -1
- package/lib/extensions/extensions-api-client-internal.js +1 -1
- package/lib/extensions/extensions-api.d.ts +1 -1
- package/lib/extensions/extensions-api.js +1 -1
- package/lib/extensions/extensions.d.ts +1 -1
- package/lib/extensions/extensions.js +1 -1
- package/lib/extensions/index.d.ts +1 -1
- package/lib/extensions/index.js +1 -1
- package/lib/firebase-namespace-api.d.ts +1 -1
- package/lib/firebase-namespace-api.js +1 -1
- package/lib/firestore/firestore-internal.d.ts +1 -1
- package/lib/firestore/firestore-internal.js +1 -1
- package/lib/firestore/firestore-namespace.d.ts +1 -1
- package/lib/firestore/firestore-namespace.js +1 -1
- package/lib/firestore/index.d.ts +1 -1
- package/lib/firestore/index.js +1 -1
- package/lib/functions/functions-api-client-internal.d.ts +1 -1
- package/lib/functions/functions-api-client-internal.js +1 -1
- package/lib/functions/functions-api.d.ts +1 -1
- package/lib/functions/functions-api.js +1 -1
- package/lib/functions/functions.d.ts +1 -1
- package/lib/functions/functions.js +1 -1
- package/lib/functions/index.d.ts +1 -1
- package/lib/functions/index.js +1 -1
- package/lib/index.d.ts +1 -1
- package/lib/index.js +1 -1
- package/lib/installations/index.d.ts +1 -1
- package/lib/installations/index.js +1 -1
- package/lib/installations/installations-namespace.d.ts +1 -1
- package/lib/installations/installations-namespace.js +1 -1
- package/lib/installations/installations-request-handler.d.ts +1 -1
- package/lib/installations/installations-request-handler.js +1 -1
- package/lib/installations/installations.d.ts +1 -1
- package/lib/installations/installations.js +1 -1
- package/lib/instance-id/index.d.ts +1 -1
- package/lib/instance-id/index.js +1 -1
- package/lib/instance-id/instance-id-namespace.d.ts +1 -1
- package/lib/instance-id/instance-id-namespace.js +1 -1
- package/lib/instance-id/instance-id.d.ts +1 -1
- package/lib/instance-id/instance-id.js +1 -1
- package/lib/machine-learning/index.d.ts +1 -1
- package/lib/machine-learning/index.js +1 -1
- package/lib/machine-learning/machine-learning-api-client.d.ts +1 -1
- package/lib/machine-learning/machine-learning-api-client.js +1 -1
- package/lib/machine-learning/machine-learning-namespace.d.ts +1 -1
- package/lib/machine-learning/machine-learning-namespace.js +1 -1
- package/lib/machine-learning/machine-learning-utils.d.ts +1 -1
- package/lib/machine-learning/machine-learning-utils.js +1 -1
- package/lib/machine-learning/machine-learning.d.ts +1 -1
- package/lib/machine-learning/machine-learning.js +1 -1
- package/lib/messaging/batch-request-internal.d.ts +1 -1
- package/lib/messaging/batch-request-internal.js +1 -1
- package/lib/messaging/index.d.ts +1 -1
- package/lib/messaging/index.js +1 -1
- package/lib/messaging/messaging-api-request-internal.d.ts +1 -1
- package/lib/messaging/messaging-api-request-internal.js +1 -1
- package/lib/messaging/messaging-api.d.ts +1 -1
- package/lib/messaging/messaging-api.js +1 -1
- package/lib/messaging/messaging-errors-internal.d.ts +1 -1
- package/lib/messaging/messaging-errors-internal.js +1 -1
- package/lib/messaging/messaging-internal.d.ts +1 -1
- package/lib/messaging/messaging-internal.js +1 -1
- package/lib/messaging/messaging-namespace.d.ts +1 -1
- package/lib/messaging/messaging-namespace.js +1 -1
- package/lib/messaging/messaging.d.ts +1 -1
- package/lib/messaging/messaging.js +1 -1
- package/lib/project-management/android-app.d.ts +1 -1
- package/lib/project-management/android-app.js +1 -1
- package/lib/project-management/app-metadata.d.ts +1 -1
- package/lib/project-management/app-metadata.js +1 -1
- package/lib/project-management/index.d.ts +1 -1
- package/lib/project-management/index.js +1 -1
- package/lib/project-management/ios-app.d.ts +1 -1
- package/lib/project-management/ios-app.js +1 -1
- package/lib/project-management/project-management-api-request-internal.d.ts +1 -1
- package/lib/project-management/project-management-api-request-internal.js +1 -1
- package/lib/project-management/project-management-namespace.d.ts +1 -1
- package/lib/project-management/project-management-namespace.js +1 -1
- package/lib/project-management/project-management.d.ts +1 -1
- package/lib/project-management/project-management.js +1 -1
- package/lib/remote-config/index.d.ts +1 -1
- package/lib/remote-config/index.js +1 -1
- package/lib/remote-config/remote-config-api-client-internal.d.ts +1 -1
- package/lib/remote-config/remote-config-api-client-internal.js +1 -1
- package/lib/remote-config/remote-config-api.d.ts +1 -1
- package/lib/remote-config/remote-config-api.js +1 -1
- package/lib/remote-config/remote-config-namespace.d.ts +1 -1
- package/lib/remote-config/remote-config-namespace.js +1 -1
- package/lib/remote-config/remote-config.d.ts +1 -1
- package/lib/remote-config/remote-config.js +1 -1
- package/lib/security-rules/index.d.ts +1 -1
- package/lib/security-rules/index.js +1 -1
- package/lib/security-rules/security-rules-api-client-internal.d.ts +1 -1
- package/lib/security-rules/security-rules-api-client-internal.js +1 -1
- package/lib/security-rules/security-rules-internal.d.ts +1 -1
- package/lib/security-rules/security-rules-internal.js +1 -1
- package/lib/security-rules/security-rules-namespace.d.ts +1 -1
- package/lib/security-rules/security-rules-namespace.js +1 -1
- package/lib/security-rules/security-rules.d.ts +1 -1
- package/lib/security-rules/security-rules.js +1 -1
- package/lib/storage/index.d.ts +1 -1
- package/lib/storage/index.js +1 -1
- package/lib/storage/storage-namespace.d.ts +1 -1
- package/lib/storage/storage-namespace.js +1 -1
- package/lib/storage/storage.d.ts +1 -1
- package/lib/storage/storage.js +1 -1
- package/lib/storage/utils.d.ts +1 -1
- package/lib/storage/utils.js +1 -1
- package/lib/utils/api-request.d.ts +1 -1
- package/lib/utils/api-request.js +1 -1
- package/lib/utils/crypto-signer.d.ts +1 -1
- package/lib/utils/crypto-signer.js +1 -1
- package/lib/utils/deep-copy.d.ts +1 -1
- package/lib/utils/deep-copy.js +1 -1
- package/lib/utils/error.d.ts +1 -1
- package/lib/utils/error.js +1 -1
- package/lib/utils/index.d.ts +1 -1
- package/lib/utils/index.js +1 -1
- package/lib/utils/jwt.d.ts +1 -1
- package/lib/utils/jwt.js +1 -1
- package/lib/utils/validator.d.ts +1 -1
- package/lib/utils/validator.js +1 -1
- package/package.json +1 -1
package/lib/app/core.d.ts
CHANGED
package/lib/app/core.js
CHANGED
package/lib/app/credential.d.ts
CHANGED
package/lib/app/credential.js
CHANGED
package/lib/app/firebase-app.js
CHANGED
package/lib/app/index.d.ts
CHANGED
package/lib/app/index.js
CHANGED
package/lib/app/lifecycle.d.ts
CHANGED
package/lib/app/lifecycle.js
CHANGED
package/lib/app-check/index.d.ts
CHANGED
package/lib/app-check/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin v11.
|
|
1
|
+
/*! firebase-admin v11.11.0 */
|
|
2
2
|
/*!
|
|
3
3
|
* Copyright 2018 Google Inc.
|
|
4
4
|
*
|
|
@@ -801,4 +801,13 @@ export interface CustomStrengthOptionsAuthServerConfig {
|
|
|
801
801
|
minPasswordLength?: number;
|
|
802
802
|
maxPasswordLength?: number;
|
|
803
803
|
}
|
|
804
|
+
/**
|
|
805
|
+
* The email privacy configuration of a project or tenant.
|
|
806
|
+
*/
|
|
807
|
+
export interface EmailPrivacyConfig {
|
|
808
|
+
/**
|
|
809
|
+
* Whether enhanced email privacy is enabled.
|
|
810
|
+
*/
|
|
811
|
+
enableImprovedEmailPrivacy?: boolean;
|
|
812
|
+
}
|
|
804
813
|
export {};
|
package/lib/auth/auth-config.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin v11.
|
|
1
|
+
/*! firebase-admin v11.11.0 */
|
|
2
2
|
"use strict";
|
|
3
3
|
/*!
|
|
4
4
|
* Copyright 2018 Google Inc.
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
* limitations under the License.
|
|
17
17
|
*/
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.PasswordPolicyAuthConfig = exports.RecaptchaAuthConfig = exports.SmsRegionsAuthConfig = exports.OIDCConfig = exports.SAMLConfig = exports.EmailSignInConfig = exports.validateTestPhoneNumbers = exports.MultiFactorAuthConfig = exports.MAXIMUM_TEST_PHONE_NUMBERS = void 0;
|
|
19
|
+
exports.EmailPrivacyAuthConfig = exports.PasswordPolicyAuthConfig = exports.RecaptchaAuthConfig = exports.SmsRegionsAuthConfig = exports.OIDCConfig = exports.SAMLConfig = exports.EmailSignInConfig = exports.validateTestPhoneNumbers = exports.MultiFactorAuthConfig = exports.MAXIMUM_TEST_PHONE_NUMBERS = void 0;
|
|
20
20
|
const validator = require("../utils/validator");
|
|
21
21
|
const deep_copy_1 = require("../utils/deep-copy");
|
|
22
22
|
const error_1 = require("../utils/error");
|
|
@@ -1046,3 +1046,28 @@ class PasswordPolicyAuthConfig {
|
|
|
1046
1046
|
}
|
|
1047
1047
|
}
|
|
1048
1048
|
exports.PasswordPolicyAuthConfig = PasswordPolicyAuthConfig;
|
|
1049
|
+
/**
|
|
1050
|
+
* Defines the EmailPrivacyAuthConfig class used for validation.
|
|
1051
|
+
*
|
|
1052
|
+
* @internal
|
|
1053
|
+
*/
|
|
1054
|
+
class EmailPrivacyAuthConfig {
|
|
1055
|
+
static validate(options) {
|
|
1056
|
+
if (!validator.isNonNullObject(options)) {
|
|
1057
|
+
throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_CONFIG, '"EmailPrivacyConfig" must be a non-null object.');
|
|
1058
|
+
}
|
|
1059
|
+
const validKeys = {
|
|
1060
|
+
enableImprovedEmailPrivacy: true,
|
|
1061
|
+
};
|
|
1062
|
+
for (const key in options) {
|
|
1063
|
+
if (!(key in validKeys)) {
|
|
1064
|
+
throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_CONFIG, `"${key}" is not a valid "EmailPrivacyConfig" parameter.`);
|
|
1065
|
+
}
|
|
1066
|
+
}
|
|
1067
|
+
if (typeof options.enableImprovedEmailPrivacy !== 'undefined'
|
|
1068
|
+
&& !validator.isBoolean(options.enableImprovedEmailPrivacy)) {
|
|
1069
|
+
throw new error_1.FirebaseAuthError(error_1.AuthClientErrorCode.INVALID_CONFIG, '"EmailPrivacyConfig.enableImprovedEmailPrivacy" must be a valid boolean value.');
|
|
1070
|
+
}
|
|
1071
|
+
}
|
|
1072
|
+
}
|
|
1073
|
+
exports.EmailPrivacyAuthConfig = EmailPrivacyAuthConfig;
|
package/lib/auth/auth.d.ts
CHANGED
package/lib/auth/auth.js
CHANGED
package/lib/auth/base-auth.d.ts
CHANGED
package/lib/auth/base-auth.js
CHANGED
package/lib/auth/identifier.d.ts
CHANGED
package/lib/auth/identifier.js
CHANGED
package/lib/auth/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin v11.
|
|
1
|
+
/*! firebase-admin v11.11.0 */
|
|
2
2
|
/*!
|
|
3
3
|
* Copyright 2020 Google Inc.
|
|
4
4
|
*
|
|
@@ -45,7 +45,7 @@ import { Auth } from './auth';
|
|
|
45
45
|
export declare function getAuth(app?: App): Auth;
|
|
46
46
|
export { ActionCodeSettings } from './action-code-settings-builder';
|
|
47
47
|
export { Auth, } from './auth';
|
|
48
|
-
export { AllowByDefault, AllowByDefaultWrap, AllowlistOnly, AllowlistOnlyWrap, AuthFactorType, AuthProviderConfig, AuthProviderConfigFilter, BaseAuthProviderConfig, BaseCreateMultiFactorInfoRequest, BaseUpdateMultiFactorInfoRequest, CreateMultiFactorInfoRequest, CreatePhoneMultiFactorInfoRequest, CreateRequest, EmailSignInProviderConfig, ListProviderConfigResults, MultiFactorConfig, MultiFactorConfigState, MultiFactorCreateSettings, MultiFactorUpdateSettings, MultiFactorProviderConfig, OAuthResponseType, OIDCAuthProviderConfig, OIDCUpdateAuthProviderRequest, RecaptchaAction, RecaptchaConfig, RecaptchaKey, RecaptchaKeyClientType, RecaptchaManagedRule, RecaptchaProviderEnforcementState, SAMLAuthProviderConfig, SAMLUpdateAuthProviderRequest, SmsRegionConfig, UserProvider, UpdateAuthProviderRequest, UpdateMultiFactorInfoRequest, UpdatePhoneMultiFactorInfoRequest, UpdateRequest, TotpMultiFactorProviderConfig, PasswordPolicyConfig, PasswordPolicyEnforcementState, CustomStrengthOptionsConfig, } from './auth-config';
|
|
48
|
+
export { AllowByDefault, AllowByDefaultWrap, AllowlistOnly, AllowlistOnlyWrap, AuthFactorType, AuthProviderConfig, AuthProviderConfigFilter, BaseAuthProviderConfig, BaseCreateMultiFactorInfoRequest, BaseUpdateMultiFactorInfoRequest, CreateMultiFactorInfoRequest, CreatePhoneMultiFactorInfoRequest, CreateRequest, EmailSignInProviderConfig, ListProviderConfigResults, MultiFactorConfig, MultiFactorConfigState, MultiFactorCreateSettings, MultiFactorUpdateSettings, MultiFactorProviderConfig, OAuthResponseType, OIDCAuthProviderConfig, OIDCUpdateAuthProviderRequest, RecaptchaAction, RecaptchaConfig, RecaptchaKey, RecaptchaKeyClientType, RecaptchaManagedRule, RecaptchaProviderEnforcementState, SAMLAuthProviderConfig, SAMLUpdateAuthProviderRequest, SmsRegionConfig, UserProvider, UpdateAuthProviderRequest, UpdateMultiFactorInfoRequest, UpdatePhoneMultiFactorInfoRequest, UpdateRequest, TotpMultiFactorProviderConfig, PasswordPolicyConfig, PasswordPolicyEnforcementState, CustomStrengthOptionsConfig, EmailPrivacyConfig, } from './auth-config';
|
|
49
49
|
export { BaseAuth, DeleteUsersResult, GetUsersResult, ListUsersResult, SessionCookieOptions, } from './base-auth';
|
|
50
50
|
export { EmailIdentifier, PhoneIdentifier, ProviderIdentifier, UidIdentifier, UserIdentifier, } from './identifier';
|
|
51
51
|
export { CreateTenantRequest, Tenant, UpdateTenantRequest, } from './tenant';
|
package/lib/auth/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
/*! firebase-admin v11.
|
|
2
|
-
import { SmsRegionConfig, MultiFactorConfig, MultiFactorAuthServerConfig, RecaptchaConfig, PasswordPolicyAuthServerConfig, PasswordPolicyConfig } from './auth-config';
|
|
1
|
+
/*! firebase-admin v11.11.0 */
|
|
2
|
+
import { SmsRegionConfig, MultiFactorConfig, MultiFactorAuthServerConfig, RecaptchaConfig, PasswordPolicyAuthServerConfig, PasswordPolicyConfig, EmailPrivacyConfig } from './auth-config';
|
|
3
3
|
/**
|
|
4
4
|
* Interface representing the properties to update on the provided project config.
|
|
5
5
|
*/
|
|
@@ -23,6 +23,10 @@ export interface UpdateProjectConfigRequest {
|
|
|
23
23
|
* The password policy configuration to update on the project
|
|
24
24
|
*/
|
|
25
25
|
passwordPolicyConfig?: PasswordPolicyConfig;
|
|
26
|
+
/**
|
|
27
|
+
* The email privacy configuration to update on the project
|
|
28
|
+
*/
|
|
29
|
+
emailPrivacyConfig?: EmailPrivacyConfig;
|
|
26
30
|
}
|
|
27
31
|
/**
|
|
28
32
|
* Response received when getting or updating the project config.
|
|
@@ -32,6 +36,7 @@ export interface ProjectConfigServerResponse {
|
|
|
32
36
|
mfa?: MultiFactorAuthServerConfig;
|
|
33
37
|
recaptchaConfig?: RecaptchaConfig;
|
|
34
38
|
passwordPolicyConfig?: PasswordPolicyAuthServerConfig;
|
|
39
|
+
emailPrivacyConfig?: EmailPrivacyConfig;
|
|
35
40
|
}
|
|
36
41
|
/**
|
|
37
42
|
* Request to update the project config.
|
|
@@ -41,6 +46,7 @@ export interface ProjectConfigClientRequest {
|
|
|
41
46
|
mfa?: MultiFactorAuthServerConfig;
|
|
42
47
|
recaptchaConfig?: RecaptchaConfig;
|
|
43
48
|
passwordPolicyConfig?: PasswordPolicyAuthServerConfig;
|
|
49
|
+
emailPrivacyConfig?: EmailPrivacyConfig;
|
|
44
50
|
}
|
|
45
51
|
/**
|
|
46
52
|
* Represents a project configuration.
|
|
@@ -57,6 +63,10 @@ export declare class ProjectConfig {
|
|
|
57
63
|
* Supports only phone and TOTP.
|
|
58
64
|
*/
|
|
59
65
|
private readonly multiFactorConfig_?;
|
|
66
|
+
/**
|
|
67
|
+
* The multi-factor auth configuration.
|
|
68
|
+
*/
|
|
69
|
+
get multiFactorConfig(): MultiFactorConfig | undefined;
|
|
60
70
|
/**
|
|
61
71
|
* The reCAPTCHA configuration to update on the project.
|
|
62
72
|
* By enabling reCAPTCHA Enterprise integration, you are
|
|
@@ -64,14 +74,14 @@ export declare class ProjectConfig {
|
|
|
64
74
|
* {@link https://cloud.google.com/terms/service-terms | Term of Service}.
|
|
65
75
|
*/
|
|
66
76
|
private readonly recaptchaConfig_?;
|
|
67
|
-
/**
|
|
68
|
-
* The multi-factor auth configuration.
|
|
69
|
-
*/
|
|
70
|
-
get multiFactorConfig(): MultiFactorConfig | undefined;
|
|
71
77
|
/**
|
|
72
78
|
* The password policy configuration for the project
|
|
73
79
|
*/
|
|
74
80
|
readonly passwordPolicyConfig?: PasswordPolicyConfig;
|
|
81
|
+
/**
|
|
82
|
+
* The email privacy configuration for the project
|
|
83
|
+
*/
|
|
84
|
+
readonly emailPrivacyConfig?: EmailPrivacyConfig;
|
|
75
85
|
/**
|
|
76
86
|
* Validates a project config options object. Throws an error on failure.
|
|
77
87
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin v11.
|
|
1
|
+
/*! firebase-admin v11.11.0 */
|
|
2
2
|
"use strict";
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.ProjectConfig = void 0;
|
|
@@ -45,6 +45,7 @@ class ProjectConfig {
|
|
|
45
45
|
multiFactorConfig: true,
|
|
46
46
|
recaptchaConfig: true,
|
|
47
47
|
passwordPolicyConfig: true,
|
|
48
|
+
emailPrivacyConfig: true,
|
|
48
49
|
};
|
|
49
50
|
// Check for unsupported top level attributes.
|
|
50
51
|
for (const key in request) {
|
|
@@ -68,6 +69,10 @@ class ProjectConfig {
|
|
|
68
69
|
if (typeof request.passwordPolicyConfig !== 'undefined') {
|
|
69
70
|
auth_config_1.PasswordPolicyAuthConfig.validate(request.passwordPolicyConfig);
|
|
70
71
|
}
|
|
72
|
+
// Validate Email Privacy Config if provided.
|
|
73
|
+
if (typeof request.emailPrivacyConfig !== 'undefined') {
|
|
74
|
+
auth_config_1.EmailPrivacyAuthConfig.validate(request.emailPrivacyConfig);
|
|
75
|
+
}
|
|
71
76
|
}
|
|
72
77
|
/**
|
|
73
78
|
* Build the corresponding server request for a UpdateProjectConfigRequest object.
|
|
@@ -91,6 +96,9 @@ class ProjectConfig {
|
|
|
91
96
|
if (typeof configOptions.passwordPolicyConfig !== 'undefined') {
|
|
92
97
|
request.passwordPolicyConfig = auth_config_1.PasswordPolicyAuthConfig.buildServerRequest(configOptions.passwordPolicyConfig);
|
|
93
98
|
}
|
|
99
|
+
if (typeof configOptions.emailPrivacyConfig !== 'undefined') {
|
|
100
|
+
request.emailPrivacyConfig = configOptions.emailPrivacyConfig;
|
|
101
|
+
}
|
|
94
102
|
return request;
|
|
95
103
|
}
|
|
96
104
|
/**
|
|
@@ -121,6 +129,9 @@ class ProjectConfig {
|
|
|
121
129
|
if (typeof response.passwordPolicyConfig !== 'undefined') {
|
|
122
130
|
this.passwordPolicyConfig = new auth_config_1.PasswordPolicyAuthConfig(response.passwordPolicyConfig);
|
|
123
131
|
}
|
|
132
|
+
if (typeof response.emailPrivacyConfig !== 'undefined') {
|
|
133
|
+
this.emailPrivacyConfig = response.emailPrivacyConfig;
|
|
134
|
+
}
|
|
124
135
|
}
|
|
125
136
|
/**
|
|
126
137
|
* Returns a JSON-serializable representation of this object.
|
|
@@ -134,6 +145,7 @@ class ProjectConfig {
|
|
|
134
145
|
multiFactorConfig: (0, deep_copy_1.deepCopy)(this.multiFactorConfig),
|
|
135
146
|
recaptchaConfig: this.recaptchaConfig_?.toJSON(),
|
|
136
147
|
passwordPolicyConfig: (0, deep_copy_1.deepCopy)(this.passwordPolicyConfig),
|
|
148
|
+
emailPrivacyConfig: (0, deep_copy_1.deepCopy)(this.emailPrivacyConfig),
|
|
137
149
|
};
|
|
138
150
|
if (typeof json.smsRegionConfig === 'undefined') {
|
|
139
151
|
delete json.smsRegionConfig;
|
|
@@ -147,6 +159,9 @@ class ProjectConfig {
|
|
|
147
159
|
if (typeof json.passwordPolicyConfig === 'undefined') {
|
|
148
160
|
delete json.passwordPolicyConfig;
|
|
149
161
|
}
|
|
162
|
+
if (typeof json.emailPrivacyConfig === 'undefined') {
|
|
163
|
+
delete json.emailPrivacyConfig;
|
|
164
|
+
}
|
|
150
165
|
return json;
|
|
151
166
|
}
|
|
152
167
|
}
|
package/lib/auth/tenant.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/*! firebase-admin v11.
|
|
1
|
+
/*! firebase-admin v11.11.0 */
|
|
2
2
|
/*!
|
|
3
3
|
* Copyright 2019 Google Inc.
|
|
4
4
|
*
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
* See the License for the specific language governing permissions and
|
|
15
15
|
* limitations under the License.
|
|
16
16
|
*/
|
|
17
|
-
import { EmailSignInConfigServerRequest, MultiFactorAuthServerConfig, MultiFactorConfig, EmailSignInProviderConfig, SmsRegionConfig, RecaptchaConfig, PasswordPolicyConfig, PasswordPolicyAuthServerConfig } from './auth-config';
|
|
17
|
+
import { EmailSignInConfigServerRequest, MultiFactorAuthServerConfig, MultiFactorConfig, EmailSignInProviderConfig, SmsRegionConfig, RecaptchaConfig, PasswordPolicyConfig, PasswordPolicyAuthServerConfig, EmailPrivacyConfig } from './auth-config';
|
|
18
18
|
/**
|
|
19
19
|
* Interface representing the properties to update on the provided tenant.
|
|
20
20
|
*/
|
|
@@ -57,6 +57,10 @@ export interface UpdateTenantRequest {
|
|
|
57
57
|
* The password policy configuration for the tenant
|
|
58
58
|
*/
|
|
59
59
|
passwordPolicyConfig?: PasswordPolicyConfig;
|
|
60
|
+
/**
|
|
61
|
+
* The email privacy configuration for the tenant
|
|
62
|
+
*/
|
|
63
|
+
emailPrivacyConfig?: EmailPrivacyConfig;
|
|
60
64
|
}
|
|
61
65
|
/**
|
|
62
66
|
* Interface representing the properties to set on a new tenant.
|
|
@@ -73,6 +77,7 @@ export interface TenantOptionsServerRequest extends EmailSignInConfigServerReque
|
|
|
73
77
|
smsRegionConfig?: SmsRegionConfig;
|
|
74
78
|
recaptchaConfig?: RecaptchaConfig;
|
|
75
79
|
passwordPolicyConfig?: PasswordPolicyAuthServerConfig;
|
|
80
|
+
emailPrivacyConfig?: EmailPrivacyConfig;
|
|
76
81
|
}
|
|
77
82
|
/** The tenant server response interface. */
|
|
78
83
|
export interface TenantServerResponse {
|
|
@@ -88,6 +93,7 @@ export interface TenantServerResponse {
|
|
|
88
93
|
smsRegionConfig?: SmsRegionConfig;
|
|
89
94
|
recaptchaConfig?: RecaptchaConfig;
|
|
90
95
|
passwordPolicyConfig?: PasswordPolicyAuthServerConfig;
|
|
96
|
+
emailPrivacyConfig?: EmailPrivacyConfig;
|
|
91
97
|
}
|
|
92
98
|
/**
|
|
93
99
|
* Represents a tenant configuration.
|
|
@@ -144,6 +150,10 @@ export declare class Tenant {
|
|
|
144
150
|
* The password policy configuration for the tenant
|
|
145
151
|
*/
|
|
146
152
|
readonly passwordPolicyConfig?: PasswordPolicyConfig;
|
|
153
|
+
/**
|
|
154
|
+
* The email privacy configuration for the tenant
|
|
155
|
+
*/
|
|
156
|
+
readonly emailPrivacyConfig?: EmailPrivacyConfig;
|
|
147
157
|
/**
|
|
148
158
|
* Validates a tenant options object. Throws an error on failure.
|
|
149
159
|
*
|