@causa/workspace-google 0.18.0-beta.2 → 0.18.0-beta.4

package/README.md

@@ -62,6 +62,10 @@ Backfilling is supported when `google.pubSub` is set as the `events.broker`. Tem
 
 When no source is specified, the default is to fetch events to backfill from the BigQuery dataset configured in `google.pubSub.bigQueryStorage`. A custom BigQuery table can also be set as source using the `bq://<projectId>.<datasetId>.<tableId>` format. It should have the `data` and `attributes` columns.
 
+The Pub/Sub publish options used when backfilling can be tuned through `google.pubSub.backfillPublishOptions`, which exposes the `maxOutstandingBytes`, `maxOutstandingMessages`, `maxBytes`, `maxMessages`, and `maxMilliseconds` fields.
+
+By default, project-scoped triggers send backfill events to the live Cloud Run service. Setting `google.cloudRun.eventBackfillServiceCloneConfig` instead deploys a temporary copy of the service for each trigger, isolating the backfill load (in particular its scaling, and therefore the load on backing resources such as databases) from production. The copy reuses the live service's revision template, restricts its ingress to internal traffic, and applies the `minInstanceCount`, `maxInstanceCount`, and `requestConcurrency` overrides from the configuration (unset fields are inherited from the live service). The copy is deleted as part of the backfill cleanup.
+
 ### Querying
 
 This module implements the `DatabaseQueryRecords`, `ServiceContainerQueryLogs`, and `EventTopicQueryEvents` workspace functions, which expose read-only access to data stored in or emitted by deployed services:

package/dist/configurations/generated.d.ts

@@ -37,6 +37,29 @@ export declare class GoogleCloudFunctions {
     readonly artefactStorage?: GoogleCloudFunctionsArtefactStorage;
     [property: string]: any;
 }
+/**
+ * When set, project-scoped backfill triggers do not send events to the live Cloud Run service. Instead, a
+ * temporary copy of the service is deployed for each trigger, isolating the backfill load (in particular its
+ * scaling) from production. The copy is deleted once the backfill is cleaned up. Ingress is always
+ * restricted to internal traffic for the copy. The properties of this object override the scaling settings
+ * of the copied service. Unset properties are inherited from the live service.
+ */
+export declare class GoogleCloudRunEventBackfillServiceCloneConfig {
+    constructor(init: GoogleCloudRunEventBackfillServiceCloneConfig);
+    /**
+     * The maximum number of instances for the temporary service copy.
+     */
+    readonly maxInstanceCount?: number;
+    /**
+     * The minimum number of instances for the temporary service copy.
+     */
+    readonly minInstanceCount?: number;
+    /**
+     * The maximum number of concurrent requests per instance for the temporary service copy.
+     */
+    readonly requestConcurrency?: number;
+    [property: string]: any;
+}
 /**
  * The type of allowed ingress that can reach the container.
  * See https://cloud.google.com/run/docs/securing/ingress#settings for more details.
@@ -67,6 +90,14 @@ export declare class GoogleCloudRun {
      * The Docker repository where Cloud Run containers should be uploaded.
      */
     readonly dockerRepository?: string;
+    /**
+     * When set, project-scoped backfill triggers do not send events to the live Cloud Run service. Instead, a
+     * temporary copy of the service is deployed for each trigger, isolating the backfill load (in particular its
+     * scaling) from production. The copy is deleted once the backfill is cleaned up. Ingress is always
+     * restricted to internal traffic for the copy. The properties of this object override the scaling settings
+     * of the copied service. Unset properties are inherited from the live service.
+     */
+    readonly eventBackfillServiceCloneConfig?: GoogleCloudRunEventBackfillServiceCloneConfig;
     /**
      * For `serviceContainer` projects deployed on Cloud Run, the name of the Cloud Run service that receives
      * events during a backfill targeting a project-scoped trigger. Defaults to the project's name
@@ -173,6 +204,11 @@ export declare class GoogleFirebaseStorageEmulator {
      * The name of the local Docker container running the emulator.
      */
     readonly containerName?: string;
+    /**
+     * The host port to which the Firebase Storage emulator is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `9199`.
+     */
+    readonly port?: number;
     [property: string]: any;
 }
 /**
@@ -203,6 +239,11 @@ export declare class GoogleFirestoreEmulator {
      * The name of the local Docker container running the emulator.
      */
     readonly containerName?: string;
+    /**
+     * The host port to which the Firestore emulator is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `8080`.
+     */
+    readonly port?: number;
     [property: string]: any;
 }
 /**
@@ -245,6 +286,11 @@ export declare class GoogleIdentityPlatformEmulator {
      * The name of the local Docker container running the emulator.
      */
     readonly containerName?: string;
+    /**
+     * The host port to which the Identity Platform (Firebase Auth) emulator is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `9099`.
+     */
+    readonly port?: number;
     [property: string]: any;
 }
 /**
@@ -269,6 +315,33 @@ export declare class GoogleLoadBalancing {
     readonly customRequestHeaders?: string[];
     [property: string]: any;
 }
+/**
+ * Options when publishing events in batches to Pub/Sub during a backfill.
+ */
+export declare class GooglePubSubBackfillPublishOptions {
+    constructor(init: GooglePubSubBackfillPublishOptions);
+    /**
+     * The maximum number of bytes to buffer before publishing a batch.
+     */
+    readonly maxBytes?: number;
+    /**
+     * The maximum number of messages to buffer before publishing a batch.
+     */
+    readonly maxMessages?: number;
+    /**
+     * The maximum duration to wait, in milliseconds, before publishing a batch.
+     */
+    readonly maxMilliseconds?: number;
+    /**
+     * The maximum number of bytes allowed in outstanding (in-flight) publish requests before applying flow control.
+     */
+    readonly maxOutstandingBytes?: number;
+    /**
+     * The maximum number of outstanding (in-flight) messages allowed before applying flow control.
+     */
+    readonly maxOutstandingMessages?: number;
+    [property: string]: any;
+}
 /**
  * Configuration for the storage of Pub/Sub events in BigQuery.
  */
@@ -294,6 +367,11 @@ export declare class GooglePubSubEmulator {
      * The name of the local Docker container running the emulator.
      */
     readonly containerName?: string;
+    /**
+     * The host port to which the Pub/Sub emulator is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `8085`.
+     */
+    readonly port?: number;
     [property: string]: any;
 }
 /**
@@ -301,6 +379,10 @@ export declare class GooglePubSubEmulator {
  */
 export declare class GooglePubSub {
     constructor(init: GooglePubSub);
+    /**
+     * Options when publishing events in batches to Pub/Sub during a backfill.
+     */
+    readonly backfillPublishOptions?: GooglePubSubBackfillPublishOptions;
     /**
      * Configuration for the storage of Pub/Sub events in BigQuery.
      */
@@ -393,6 +475,16 @@ export declare class GoogleSpannerEmulator {
      * The name of the local Docker container running the emulator.
      */
     readonly containerName?: string;
+    /**
+     * The host port to which the Spanner emulator gRPC API is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `9010`.
+     */
+    readonly grpcPort?: number;
+    /**
+     * The host port to which the Spanner emulator HTTP API is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `9020`.
+     */
+    readonly httpPort?: number;
     /**
      * The name of the Spanner instance that will automatically be created in the emulator.
      */

package/dist/configurations/generated.js

@@ -76,6 +76,45 @@ __decorate([
     AllowMissing(),
     __metadata("design:type", GoogleCloudFunctionsArtefactStorage)
 ], GoogleCloudFunctions.prototype, "artefactStorage", void 0);
+/**
+ * When set, project-scoped backfill triggers do not send events to the live Cloud Run service. Instead, a
+ * temporary copy of the service is deployed for each trigger, isolating the backfill load (in particular its
+ * scaling) from production. The copy is deleted once the backfill is cleaned up. Ingress is always
+ * restricted to internal traffic for the copy. The properties of this object override the scaling settings
+ * of the copied service. Unset properties are inherited from the live service.
+ */
+export class GoogleCloudRunEventBackfillServiceCloneConfig {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    /**
+     * The maximum number of instances for the temporary service copy.
+     */
+    maxInstanceCount;
+    /**
+     * The minimum number of instances for the temporary service copy.
+     */
+    minInstanceCount;
+    /**
+     * The maximum number of concurrent requests per instance for the temporary service copy.
+     */
+    requestConcurrency;
+}
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GoogleCloudRunEventBackfillServiceCloneConfig.prototype, "maxInstanceCount", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GoogleCloudRunEventBackfillServiceCloneConfig.prototype, "minInstanceCount", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GoogleCloudRunEventBackfillServiceCloneConfig.prototype, "requestConcurrency", void 0);
 /**
  * The type of allowed ingress that can reach the container.
  * See https://cloud.google.com/run/docs/securing/ingress#settings for more details.
@@ -110,6 +149,14 @@ export class GoogleCloudRun {
      * The Docker repository where Cloud Run containers should be uploaded.
      */
     dockerRepository;
+    /**
+     * When set, project-scoped backfill triggers do not send events to the live Cloud Run service. Instead, a
+     * temporary copy of the service is deployed for each trigger, isolating the backfill load (in particular its
+     * scaling) from production. The copy is deleted once the backfill is cleaned up. Ingress is always
+     * restricted to internal traffic for the copy. The properties of this object override the scaling settings
+     * of the copied service. Unset properties are inherited from the live service.
+     */
+    eventBackfillServiceCloneConfig;
     /**
      * For `serviceContainer` projects deployed on Cloud Run, the name of the Cloud Run service that receives
      * events during a backfill targeting a project-scoped trigger. Defaults to the project's name
@@ -162,6 +209,10 @@ __decorate([
     IsString(),
     __metadata("design:type", String)
 ], GoogleCloudRun.prototype, "dockerRepository", void 0);
+__decorate([
+    AllowMissing(),
+    __metadata("design:type", GoogleCloudRunEventBackfillServiceCloneConfig)
+], GoogleCloudRun.prototype, "eventBackfillServiceCloneConfig", void 0);
 __decorate([
     AllowMissing(),
     IsString(),
@@ -301,12 +352,22 @@ export class GoogleFirebaseStorageEmulator {
      * The name of the local Docker container running the emulator.
      */
     containerName;
+    /**
+     * The host port to which the Firebase Storage emulator is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `9199`.
+     */
+    port;
 }
 __decorate([
     AllowMissing(),
     IsString(),
     __metadata("design:type", String)
 ], GoogleFirebaseStorageEmulator.prototype, "containerName", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GoogleFirebaseStorageEmulator.prototype, "port", void 0);
 /**
  * Configuration for the Firebase Storage service.
  */
@@ -353,12 +414,22 @@ export class GoogleFirestoreEmulator {
      * The name of the local Docker container running the emulator.
      */
     containerName;
+    /**
+     * The host port to which the Firestore emulator is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `8080`.
+     */
+    port;
 }
 __decorate([
     AllowMissing(),
     IsString(),
     __metadata("design:type", String)
 ], GoogleFirestoreEmulator.prototype, "containerName", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GoogleFirestoreEmulator.prototype, "port", void 0);
 /**
  * Configuration for the Firestore service.
  */
@@ -423,12 +494,22 @@ export class GoogleIdentityPlatformEmulator {
      * The name of the local Docker container running the emulator.
      */
     containerName;
+    /**
+     * The host port to which the Identity Platform (Firebase Auth) emulator is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `9099`.
+     */
+    port;
 }
 __decorate([
     AllowMissing(),
     IsString(),
     __metadata("design:type", String)
 ], GoogleIdentityPlatformEmulator.prototype, "containerName", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GoogleIdentityPlatformEmulator.prototype, "port", void 0);
 /**
  * Configuration for the Identity Platform (formerly Firebase Auth) service.
  */
@@ -463,6 +544,59 @@ __decorate([
     IsString({ each: true }),
     __metadata("design:type", Array)
 ], GoogleLoadBalancing.prototype, "customRequestHeaders", void 0);
+/**
+ * Options when publishing events in batches to Pub/Sub during a backfill.
+ */
+export class GooglePubSubBackfillPublishOptions {
+    constructor(init) {
+        Object.assign(this, init);
+    }
+    /**
+     * The maximum number of bytes to buffer before publishing a batch.
+     */
+    maxBytes;
+    /**
+     * The maximum number of messages to buffer before publishing a batch.
+     */
+    maxMessages;
+    /**
+     * The maximum duration to wait, in milliseconds, before publishing a batch.
+     */
+    maxMilliseconds;
+    /**
+     * The maximum number of bytes allowed in outstanding (in-flight) publish requests before applying flow control.
+     */
+    maxOutstandingBytes;
+    /**
+     * The maximum number of outstanding (in-flight) messages allowed before applying flow control.
+     */
+    maxOutstandingMessages;
+}
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GooglePubSubBackfillPublishOptions.prototype, "maxBytes", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GooglePubSubBackfillPublishOptions.prototype, "maxMessages", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GooglePubSubBackfillPublishOptions.prototype, "maxMilliseconds", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GooglePubSubBackfillPublishOptions.prototype, "maxOutstandingBytes", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GooglePubSubBackfillPublishOptions.prototype, "maxOutstandingMessages", void 0);
 /**
  * Configuration for the storage of Pub/Sub events in BigQuery.
  */
@@ -501,12 +635,22 @@ export class GooglePubSubEmulator {
      * The name of the local Docker container running the emulator.
      */
     containerName;
+    /**
+     * The host port to which the Pub/Sub emulator is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `8085`.
+     */
+    port;
 }
 __decorate([
     AllowMissing(),
     IsString(),
     __metadata("design:type", String)
 ], GooglePubSubEmulator.prototype, "containerName", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GooglePubSubEmulator.prototype, "port", void 0);
 /**
  * Configuration for the Pub/Sub service.
  */
@@ -514,6 +658,10 @@ export class GooglePubSub {
     constructor(init) {
         Object.assign(this, init);
     }
+    /**
+     * Options when publishing events in batches to Pub/Sub during a backfill.
+     */
+    backfillPublishOptions;
     /**
      * Configuration for the storage of Pub/Sub events in BigQuery.
      */
@@ -535,6 +683,10 @@ export class GooglePubSub {
      */
     topicConfigurationsDirectory;
 }
+__decorate([
+    AllowMissing(),
+    __metadata("design:type", GooglePubSubBackfillPublishOptions)
+], GooglePubSub.prototype, "backfillPublishOptions", void 0);
 __decorate([
     AllowMissing(),
     __metadata("design:type", GooglePubSubBigQueryStorage)
@@ -684,6 +836,16 @@ export class GoogleSpannerEmulator {
      * The name of the local Docker container running the emulator.
      */
     containerName;
+    /**
+     * The host port to which the Spanner emulator gRPC API is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `9010`.
+     */
+    grpcPort;
+    /**
+     * The host port to which the Spanner emulator HTTP API is bound.
+     * Override this to run several workspaces in parallel on the same machine. Defaults to `9020`.
+     */
+    httpPort;
     /**
      * The name of the Spanner instance that will automatically be created in the emulator.
      */
@@ -698,6 +860,16 @@ __decorate([
     IsString(),
     __metadata("design:type", String)
 ], GoogleSpannerEmulator.prototype, "containerName", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GoogleSpannerEmulator.prototype, "grpcPort", void 0);
+__decorate([
+    AllowMissing(),
+    IsNumber(),
+    __metadata("design:type", Number)
+], GoogleSpannerEmulator.prototype, "httpPort", void 0);
 __decorate([
     AllowMissing(),
     IsString(),

package/dist/configurations/schemas/google.yaml

@@ -125,6 +125,13 @@ properties:
               containerName:
                 type: string
                 description: The name of the local Docker container running the emulator.
+              port:
+                type: number
+                description: >-
+                  The host port to which the Firebase Storage emulator is bound.
+
+                  Override this to run several workspaces in parallel on the
+                  same machine. Defaults to `9199`.
           securityRuleFiles:
             type: array
             items:
@@ -149,6 +156,14 @@ properties:
               containerName:
                 type: string
                 description: The name of the local Docker container running the emulator.
+              port:
+                type: number
+                description: >-
+                  The host port to which the Identity Platform (Firebase Auth)
+                  emulator is bound.
+
+                  Override this to run several workspaces in parallel on the
+                  same machine. Defaults to `9099`.
       firestore:
         title: GoogleFirestore
         type: object
@@ -162,6 +177,13 @@ properties:
               containerName:
                 type: string
                 description: The name of the local Docker container running the emulator.
+              port:
+                type: number
+                description: >-
+                  The host port to which the Firestore emulator is bound.
+
+                  Override this to run several workspaces in parallel on the
+                  same machine. Defaults to `8080`.
           securityRuleFiles:
             type: array
             items:
@@ -185,6 +207,13 @@ properties:
               containerName:
                 type: string
                 description: The name of the local Docker container running the emulator.
+              port:
+                type: number
+                description: >-
+                  The host port to which the Pub/Sub emulator is bound.
+
+                  Override this to run several workspaces in parallel on the
+                  same machine. Defaults to `8085`.
           topicConfigurationsDirectory:
             type: string
             description: The directory where the topic configuration files are written by
@@ -213,6 +242,30 @@ properties:
 
                   See https://cloud.google.com/bigquery/docs/locations for more
                   details.
+          backfillPublishOptions:
+            title: GooglePubSubBackfillPublishOptions
+            type: object
+            description: Options when publishing events in batches to Pub/Sub during a
+              backfill.
+            properties:
+              maxOutstandingBytes:
+                type: number
+                description: The maximum number of bytes allowed in outstanding (in-flight)
+                  publish requests before applying flow control.
+              maxOutstandingMessages:
+                type: number
+                description: The maximum number of outstanding (in-flight) messages allowed
+                  before applying flow control.
+              maxBytes:
+                type: number
+                description: The maximum number of bytes to buffer before publishing a batch.
+              maxMessages:
+                type: number
+                description: The maximum number of messages to buffer before publishing a batch.
+              maxMilliseconds:
+                type: number
+                description: The maximum duration to wait, in milliseconds, before publishing a
+                  batch.
       spanner:
         title: GoogleSpanner
         type: object
@@ -233,6 +286,20 @@ properties:
                 type: string
                 description: The name of the Spanner instance that will automatically be created
                   in the emulator.
+              grpcPort:
+                type: number
+                description: >-
+                  The host port to which the Spanner emulator gRPC API is bound.
+
+                  Override this to run several workspaces in parallel on the
+                  same machine. Defaults to `9010`.
+              httpPort:
+                type: number
+                description: >-
+                  The host port to which the Spanner emulator HTTP API is bound.
+
+                  Override this to run several workspaces in parallel on the
+                  same machine. Defaults to `9020`.
           instance:
             title: GoogleSpannerInstance
             type: object
@@ -346,6 +413,35 @@ properties:
               Defaults to the project's name
 
               (`project.name`) when unset.
+          eventBackfillServiceCloneConfig:
+            title: GoogleCloudRunEventBackfillServiceCloneConfig
+            type: object
+            description: >-
+              When set, project-scoped backfill triggers do not send events to
+              the live Cloud Run service. Instead, a
+
+              temporary copy of the service is deployed for each trigger,
+              isolating the backfill load (in particular its
+
+              scaling) from production. The copy is deleted once the backfill is
+              cleaned up. Ingress is always
+
+              restricted to internal traffic for the copy. The properties of
+              this object override the scaling settings
+
+              of the copied service. Unset properties are inherited from the
+              live service.
+            properties:
+              minInstanceCount:
+                type: number
+                description: The minimum number of instances for the temporary service copy.
+              maxInstanceCount:
+                type: number
+                description: The maximum number of instances for the temporary service copy.
+              requestConcurrency:
+                type: number
+                description: The maximum number of concurrent requests per instance for the
+                  temporary service copy.
           secretEnvironmentVariables:
             type: object
             description: >-

package/dist/emulators/firebase-storage.d.ts

@@ -11,9 +11,17 @@ export declare const FIREBASE_STORAGE_EMULATOR_NAME = "google.firebaseStorage";
  */
 export declare function getFirebaseStorageContainerName(context: WorkspaceContext): string;
 /**
- * The exposed port for Firebase Storage.
+ * The default exposed host port for Firebase Storage.
  */
 export declare const FIREBASE_STORAGE_PORT = 9199;
+/**
+ * Returns the host port to which the Firebase Storage emulator should be bound.
+ * Reads `google.firebaseStorage.emulator.port`, falling back to {@link FIREBASE_STORAGE_PORT}.
+ *
+ * @param context The {@link WorkspaceContext}.
+ * @returns The host port for the Firebase Storage emulator.
+ */
+export declare function getFirebaseStorageEmulatorPort(context: WorkspaceContext): number;
 /**
  * The location of the Firebase Storage security rules file within the container.
  */

package/dist/emulators/firebase-storage.js

@@ -19,9 +19,21 @@ export function getFirebaseStorageContainerName(context) {
     return `${workspaceName}-firebase-storage`;
 }
 /**
- * The exposed port for Firebase Storage.
+ * The default exposed host port for Firebase Storage.
  */
 export const FIREBASE_STORAGE_PORT = 9199;
+/**
+ * Returns the host port to which the Firebase Storage emulator should be bound.
+ * Reads `google.firebaseStorage.emulator.port`, falling back to {@link FIREBASE_STORAGE_PORT}.
+ *
+ * @param context The {@link WorkspaceContext}.
+ * @returns The host port for the Firebase Storage emulator.
+ */
+export function getFirebaseStorageEmulatorPort(context) {
+    return (context
+        .asConfiguration()
+        .get('google.firebaseStorage.emulator.port') ?? FIREBASE_STORAGE_PORT);
+}
 /**
  * The location of the Firebase Storage security rules file within the container.
  */

package/dist/emulators/firestore.d.ts

@@ -15,6 +15,14 @@ export declare function getFirestoreContainerName(context: WorkspaceContext): st
  */
 export declare const FIRESTORE_CONTAINER_RULES_FILE = "/firestore.rules";
 /**
- * The port on which the Firestore emulator listens.
+ * The default host port on which the Firestore emulator listens.
  */
 export declare const FIRESTORE_PORT = 8080;
+/**
+ * Returns the host port to which the Firestore emulator should be bound.
+ * Reads `google.firestore.emulator.port`, falling back to {@link FIRESTORE_PORT}.
+ *
+ * @param context The {@link WorkspaceContext}.
+ * @returns The host port for the Firestore emulator.
+ */
+export declare function getFirestoreEmulatorPort(context: WorkspaceContext): number;

package/dist/emulators/firestore.js

@@ -23,6 +23,18 @@ export function getFirestoreContainerName(context) {
  */
 export const FIRESTORE_CONTAINER_RULES_FILE = '/firestore.rules';
 /**
- * The port on which the Firestore emulator listens.
+ * The default host port on which the Firestore emulator listens.
  */
 export const FIRESTORE_PORT = 8080;
+/**
+ * Returns the host port to which the Firestore emulator should be bound.
+ * Reads `google.firestore.emulator.port`, falling back to {@link FIRESTORE_PORT}.
+ *
+ * @param context The {@link WorkspaceContext}.
+ * @returns The host port for the Firestore emulator.
+ */
+export function getFirestoreEmulatorPort(context) {
+    return (context
+        .asConfiguration()
+        .get('google.firestore.emulator.port') ?? FIRESTORE_PORT);
+}

package/dist/emulators/identity-platform.d.ts

@@ -11,6 +11,14 @@ export declare const IDENTITY_PLATFORM_EMULATOR_NAME = "google.identityPlatform"
  */
 export declare function getIdentityPlatformContainerName(context: WorkspaceContext): string;
 /**
- * The port on which the Firebase Auth emulator is listening.
+ * The default host port on which the Firebase Auth emulator is listening.
  */
 export declare const FIREBASE_AUTH_PORT = 9099;
+/**
+ * Returns the host port to which the Identity Platform (Firebase Auth) emulator should be bound.
+ * Reads `google.identityPlatform.emulator.port`, falling back to {@link FIREBASE_AUTH_PORT}.
+ *
+ * @param context The {@link WorkspaceContext}.
+ * @returns The host port for the Identity Platform emulator.
+ */
+export declare function getIdentityPlatformEmulatorPort(context: WorkspaceContext): number;