Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add RemoteConfigServerTemplateOptions type and update extracted API
  • Loading branch information
erikeldridge committed Feb 14, 2024
commit 8c883bc8b8d8de1afcc8e7fa95b1434c9389de95
39 changes: 39 additions & 0 deletions etc/firebase-admin.remote-config.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,10 @@ export class RemoteConfig {
// (undocumented)
readonly app: App;
createTemplateFromJSON(json: string): RemoteConfigTemplate;
getServerTemplate(options?: RemoteConfigServerTemplateOptions): Promise<RemoteConfigServerTemplate>;
getTemplate(): Promise<RemoteConfigTemplate>;
getTemplateAtVersion(versionNumber: number | string): Promise<RemoteConfigTemplate>;
initServerTemplate(options?: RemoteConfigServerTemplateOptions): RemoteConfigServerTemplate;
listVersions(options?: ListVersionsOptions): Promise<ListVersionsResult>;
publishTemplate(template: RemoteConfigTemplate, options?: {
force: boolean;
Expand Down Expand Up @@ -84,6 +86,43 @@ export interface RemoteConfigParameterGroup {
// @public
export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

// @public
export interface RemoteConfigServerCondition {
expression: string;
name: string;
}

// @public
export type RemoteConfigServerConfig = {
[key: string]: string | boolean | number;
};

// @public
export interface RemoteConfigServerTemplate {
cache: RemoteConfigServerTemplateData;
defaultConfig: RemoteConfigServerConfig;
evaluate(): RemoteConfigServerConfig;
load(): Promise<void>;
}

// @public
export interface RemoteConfigServerTemplateData {
conditions: RemoteConfigServerCondition[];
readonly etag: string;
parameters: {
[key: string]: RemoteConfigParameter;
};
version?: Version;
}

// @public
export interface RemoteConfigServerTemplateOptions {
// (undocumented)
defaultConfig?: RemoteConfigServerConfig;
// (undocumented)
template?: RemoteConfigServerTemplateData;
}

// @public
export interface RemoteConfigTemplate {
conditions: RemoteConfigCondition[];
Expand Down
2 changes: 2 additions & 0 deletions src/remote-config/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,11 @@ export {
RemoteConfigParameterGroup,
RemoteConfigParameterValue,
RemoteConfigTemplate,
RemoteConfigServerCondition,
RemoteConfigServerConfig,
RemoteConfigServerTemplate,
RemoteConfigServerTemplateData,
RemoteConfigServerTemplateOptions,
RemoteConfigUser,
TagColor,
Version,
Expand Down
8 changes: 8 additions & 0 deletions src/remote-config/remote-config-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,14 @@ export interface RemoteConfigServerTemplateData {
version?: Version;
}

/**
* Interface representing optional arguments for instantiating {@link RemoteConfigServerTemplate}.
*/
export interface RemoteConfigServerTemplateOptions {
defaultConfig?: RemoteConfigServerConfig,
template?: RemoteConfigServerTemplateData,
}

/**
* Interface representing a stateful abstraction for a Remote Config server template.
*/
Expand Down
13 changes: 4 additions & 9 deletions src/remote-config/remote-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ import {
InAppDefaultValue,
ParameterValueType,
RemoteConfigServerConfig,
RemoteConfigServerTemplateData
RemoteConfigServerTemplateData,
RemoteConfigServerTemplateOptions,
} from './remote-config-api';

/**
Expand Down Expand Up @@ -179,10 +180,7 @@ export class RemoteConfig {
* Instantiates {@link RemoteConfigServerTemplate} and then fetches and caches the latest
* template version of the project.
*/
public async getServerTemplate(options?: {
defaultConfig?: RemoteConfigServerConfig,
template?: RemoteConfigServerTemplateData,
}): Promise<RemoteConfigServerTemplate> {
public async getServerTemplate(options?: RemoteConfigServerTemplateOptions): Promise<RemoteConfigServerTemplate> {
const template = this.initServerTemplate(options);
await template.load();
return template;
Expand All @@ -191,10 +189,7 @@ export class RemoteConfig {
/**
* Synchronously instantiates {@link RemoteConfigServerTemplate}.
*/
public initServerTemplate(options?: {
defaultConfig?: RemoteConfigServerConfig,
template?: RemoteConfigServerTemplateData,
}): RemoteConfigServerTemplate {
public initServerTemplate(options?: RemoteConfigServerTemplateOptions): RemoteConfigServerTemplate {
const template = new RemoteConfigServerTemplateImpl(this.client, options?.defaultConfig);
if (options?.template) {
template.cache = options?.template;
Expand Down