firebase-admin 10.0.2 → 10.3.0

package/lib/eventarc/eventarc-utils.d.ts

@@ -0,0 +1,31 @@
+/*! firebase-admin v10.3.0 */
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * 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.
+ */
+import { PrefixedFirebaseError } from '../utils/error';
+import { CloudEvent } from './cloudevent';
+export declare type EventarcErrorCode = 'unknown-error' | 'invalid-argument';
+/**
+ * Firebase Eventarc error code structure. This extends PrefixedFirebaseError.
+ *
+ * @param code - The error code.
+ * @param message - The error message.
+ * @constructor
+ */
+export declare class FirebaseEventarcError extends PrefixedFirebaseError {
+    constructor(code: EventarcErrorCode, message: string);
+}
+export declare function toCloudEventProtoFormat(ce: CloudEvent): any;

package/lib/eventarc/eventarc-utils.js

@@ -0,0 +1,141 @@
+/*! firebase-admin v10.3.0 */
+"use strict";
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * 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.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCloudEventProtoFormat = exports.FirebaseEventarcError = void 0;
+var error_1 = require("../utils/error");
+var uuid_1 = require("uuid");
+var validator = require("../utils/validator");
+// List of CloudEvent properties that are handled "by hand" and should be skipped by
+// automatic attribute copy.
+var TOP_LEVEL_CE_ATTRS = ['id', 'type', 'specversion', 'source', 'data', 'time', 'datacontenttype', 'subject'];
+/**
+ * Firebase Eventarc error code structure. This extends PrefixedFirebaseError.
+ *
+ * @param code - The error code.
+ * @param message - The error message.
+ * @constructor
+ */
+var FirebaseEventarcError = /** @class */ (function (_super) {
+    __extends(FirebaseEventarcError, _super);
+    function FirebaseEventarcError(code, message) {
+        return _super.call(this, 'eventarc', code, message) || this;
+    }
+    return FirebaseEventarcError;
+}(error_1.PrefixedFirebaseError));
+exports.FirebaseEventarcError = FirebaseEventarcError;
+function toCloudEventProtoFormat(ce) {
+    var _a, _b, _c;
+    var source = (_a = ce.source) !== null && _a !== void 0 ? _a : process.env.EVENTARC_CLOUD_EVENT_SOURCE;
+    if (typeof source === 'undefined' || !validator.isNonEmptyString(source)) {
+        throw new FirebaseEventarcError('invalid-argument', "CloudEvent 'source' is required.");
+    }
+    if (!validator.isNonEmptyString(ce.type)) {
+        throw new FirebaseEventarcError('invalid-argument', "CloudEvent 'type' is required.");
+    }
+    var out = {
+        '@type': 'type.googleapis.com/io.cloudevents.v1.CloudEvent',
+        'id': (_b = ce.id) !== null && _b !== void 0 ? _b : uuid_1.v4(),
+        'type': ce.type,
+        'specVersion': (_c = ce.specversion) !== null && _c !== void 0 ? _c : '1.0',
+        'source': source
+    };
+    if (typeof ce.time !== 'undefined') {
+        if (!validator.isISODateString(ce.time)) {
+            throw new FirebaseEventarcError('invalid-argument', "CloudEvent 'tyme' must be in ISO date format.");
+        }
+        setAttribute(out, 'time', {
+            'ceTimestamp': ce.time
+        });
+    }
+    else {
+        setAttribute(out, 'time', {
+            'ceTimestamp': new Date().toISOString()
+        });
+    }
+    if (typeof ce.datacontenttype !== 'undefined') {
+        if (!validator.isNonEmptyString(ce.datacontenttype)) {
+            throw new FirebaseEventarcError('invalid-argument', "CloudEvent 'datacontenttype' if specified must be non-empty string.");
+        }
+        setAttribute(out, 'datacontenttype', {
+            'ceString': ce.datacontenttype
+        });
+    }
+    if (ce.subject) {
+        if (!validator.isNonEmptyString(ce.subject)) {
+            throw new FirebaseEventarcError('invalid-argument', "CloudEvent 'subject' if specified must be non-empty string.");
+        }
+        setAttribute(out, 'subject', {
+            'ceString': ce.subject
+        });
+    }
+    if (typeof ce.data === 'undefined') {
+        throw new FirebaseEventarcError('invalid-argument', "CloudEvent 'data' is required.");
+    }
+    if (validator.isObject(ce.data)) {
+        out['textData'] = JSON.stringify(ce.data);
+        if (!ce.datacontenttype) {
+            setAttribute(out, 'datacontenttype', {
+                'ceString': 'application/json'
+            });
+        }
+    }
+    else if (validator.isNonEmptyString(ce.data)) {
+        out['textData'] = ce.data;
+        if (!ce.datacontenttype) {
+            setAttribute(out, 'datacontenttype', {
+                'ceString': 'text/plain'
+            });
+        }
+    }
+    else {
+        throw new FirebaseEventarcError('invalid-argument', "CloudEvent 'data' must be string or an object (which are converted to JSON), got '" + typeof ce.data + "'.");
+    }
+    for (var attr in ce) {
+        if (TOP_LEVEL_CE_ATTRS.includes(attr)) {
+            continue;
+        }
+        if (!validator.isNonEmptyString(ce[attr])) {
+            throw new FirebaseEventarcError('invalid-argument', "CloudEvent extension attributes ('" + attr + "') must be string.");
+        }
+        setAttribute(out, attr, {
+            'ceString': ce[attr]
+        });
+    }
+    return out;
+}
+exports.toCloudEventProtoFormat = toCloudEventProtoFormat;
+function setAttribute(event, attr, value) {
+    if (!Object.prototype.hasOwnProperty.call(event, 'attributes')) {
+        event.attributes = {};
+    }
+    event['attributes'][attr] = value;
+}

package/lib/eventarc/eventarc.d.ts

@@ -0,0 +1,107 @@
+/*! firebase-admin v10.3.0 */
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * 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.
+ */
+import { App } from '../app';
+import { CloudEvent } from './cloudevent';
+/**
+ * Channel options interface.
+ */
+export interface ChannelOptions {
+    /**
+     * An array of allowed event types. If specified, publishing events of
+     * unknown types is a no op. When not provided, no event filtering is
+     * performed.
+     */
+    allowedEventTypes?: string[] | string | undefined;
+}
+/**
+ * Eventarc service bound to the provided app.
+ */
+export declare class Eventarc {
+    private readonly appInternal;
+    /**
+     * The {@link firebase-admin.app#App} associated with the current Eventarc service
+     * instance.
+     *
+     * @example
+     * ```javascript
+     * var app = eventarc.app;
+     * ```
+     */
+    get app(): App;
+    /**
+     * Creates a reference to the Eventarc channel using the provided channel resource name.
+     * The channel resource name can be either:
+     *
+     * - A fully qualified channel resource name:
+     *     `projects/{project}/locations/{location}/channels/{channel-id}`
+     *
+     * - A partial resource name with location and channel ID, in which case
+     *     the runtime project ID of the function is used:
+     *     `locations/{location}/channels/{channel-id}`
+     *
+     * - A partial channel ID, in which case the runtime project ID of the
+     *     function and `us-central1` as location is used:
+     *     `{channel-id}`
+     *
+     * @param name - Channel resource name.
+     * @param options - (optional) additional channel options
+     * @returns An Eventarc channel reference for publishing events.
+     */
+    channel(name: string, options?: ChannelOptions): Channel;
+    /**
+     * Create a reference to the default Firebase channel:
+     * `locations/us-central1/channels/firebase`
+     *
+     * @param options - (optional) additional channel options
+     * @returns Eventarc channel reference for publishing events.
+     */
+    channel(options?: ChannelOptions): Channel;
+}
+/**
+ * Eventarc Channel.
+ */
+export declare class Channel {
+    private readonly eventarcInternal;
+    private nameInternal;
+    /**
+     * List of event types allowed by this channel for publishing. Other event types are ignored.
+     */
+    readonly allowedEventTypes?: string[];
+    private readonly client;
+    /**
+     * The {@link firebase-admin.eventarc#Eventarc} service instance associated with the current `Channel`.
+     *
+     * @example
+     * ```javascript
+     * var app = channel.eventarc;
+     * ```
+     */
+    get eventarc(): Eventarc;
+    /**
+     * The channel name as provided during channel creation. If it was not specifed, the default channel name is returned
+     * ('locations/us-central1/channels/firebase').
+     */
+    get name(): string;
+    /**
+     * Publishes provided events to this channel. If channel was created with `allowedEventTypes` and event type is not
+     * on that list, the event is ignored.
+     *
+     * @param events - CloudEvent to publish to the channel.
+     */
+    publish(events: CloudEvent | CloudEvent[]): Promise<void>;
+}

package/lib/eventarc/eventarc.js

@@ -0,0 +1,139 @@
+/*! firebase-admin v10.3.0 */
+"use strict";
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Channel = exports.Eventarc = void 0;
+var validator = require("../utils/validator");
+var eventarc_utils_1 = require("./eventarc-utils");
+var eventarc_client_internal_1 = require("./eventarc-client-internal");
+/**
+ * Eventarc service bound to the provided app.
+ */
+var Eventarc = /** @class */ (function () {
+    /**
+     * @internal
+     */
+    function Eventarc(app) {
+        if (!validator.isNonNullObject(app) || !('options' in app)) {
+            throw new eventarc_utils_1.FirebaseEventarcError('invalid-argument', 'First argument passed to Eventarc() must be a valid Firebase app instance.');
+        }
+        this.appInternal = app;
+    }
+    Object.defineProperty(Eventarc.prototype, "app", {
+        /**
+         * The {@link firebase-admin.app#App} associated with the current Eventarc service
+         * instance.
+         *
+         * @example
+         * ```javascript
+         * var app = eventarc.app;
+         * ```
+         */
+        get: function () {
+            return this.appInternal;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Eventarc.prototype.channel = function (nameOrOptions, options) {
+        var channel;
+        var opts;
+        if (validator.isNonEmptyString(nameOrOptions)) {
+            channel = nameOrOptions;
+        }
+        else {
+            channel = 'locations/us-central1/channels/firebase';
+        }
+        if (validator.isNonNullObject(nameOrOptions)) {
+            opts = nameOrOptions;
+        }
+        else {
+            opts = options;
+        }
+        var allowedEventTypes = undefined;
+        if (typeof (opts === null || opts === void 0 ? void 0 : opts.allowedEventTypes) === 'string') {
+            allowedEventTypes = opts.allowedEventTypes.split(',');
+        }
+        else if (validator.isArray(opts === null || opts === void 0 ? void 0 : opts.allowedEventTypes)) {
+            allowedEventTypes = opts === null || opts === void 0 ? void 0 : opts.allowedEventTypes;
+        }
+        else if (typeof (opts === null || opts === void 0 ? void 0 : opts.allowedEventTypes) !== 'undefined') {
+            throw new eventarc_utils_1.FirebaseEventarcError('invalid-argument', 'AllowedEventTypes must be either an array of strings or a comma separated string.');
+        }
+        return new Channel(this, channel, allowedEventTypes);
+    };
+    return Eventarc;
+}());
+exports.Eventarc = Eventarc;
+/**
+ * Eventarc Channel.
+ */
+var Channel = /** @class */ (function () {
+    /**
+     * @internal
+     */
+    function Channel(eventarc, name, allowedEventTypes) {
+        if (!validator.isNonNullObject(eventarc)) {
+            throw new eventarc_utils_1.FirebaseEventarcError('invalid-argument', 'First argument passed to Channel() must be a valid Eventarc service instance.');
+        }
+        if (!validator.isNonEmptyString(name)) {
+            throw new eventarc_utils_1.FirebaseEventarcError('invalid-argument', 'name is required.');
+        }
+        this.nameInternal = name;
+        this.eventarcInternal = eventarc;
+        this.allowedEventTypes = allowedEventTypes;
+        this.client = new eventarc_client_internal_1.EventarcApiClient(eventarc.app, this);
+    }
+    Object.defineProperty(Channel.prototype, "eventarc", {
+        /**
+         * The {@link firebase-admin.eventarc#Eventarc} service instance associated with the current `Channel`.
+         *
+         * @example
+         * ```javascript
+         * var app = channel.eventarc;
+         * ```
+         */
+        get: function () {
+            return this.eventarcInternal;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Channel.prototype, "name", {
+        /**
+         * The channel name as provided during channel creation. If it was not specifed, the default channel name is returned
+         * ('locations/us-central1/channels/firebase').
+         */
+        get: function () {
+            return this.nameInternal;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Publishes provided events to this channel. If channel was created with `allowedEventTypes` and event type is not
+     * on that list, the event is ignored.
+     *
+     * @param events - CloudEvent to publish to the channel.
+     */
+    Channel.prototype.publish = function (events) {
+        return this.client.publish(events);
+    };
+    return Channel;
+}());
+exports.Channel = Channel;

package/lib/eventarc/index.d.ts

@@ -0,0 +1,53 @@
+/*! firebase-admin v10.3.0 */
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * 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.
+ */
+/**
+ * Firebase Eventarc.
+ *
+ * @packageDocumentation
+ */
+import { App } from '../app';
+import { Eventarc } from './eventarc';
+export { CloudEvent, CloudEventVersion } from './cloudevent';
+export { Eventarc, Channel, ChannelOptions } from './eventarc';
+/**
+ * Gets the {@link Eventarc} service for the default app or a given app.
+ *
+ * `getEventarc()` can be called with no arguments to access the default
+ * app's `Eventarc` service or as `getEventarc(app)` to access the
+ * `Eventarc` service associated with specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the Eventarc service for the default app
+ * const defaultEventarc = getEventarc();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the Eventarc service for a given app
+ * const otherEventarc = getEventarc(otherApp);
+ * ```
+ *
+ * @param app - Optional app whose `Eventarc` service will be returned.
+ *   If not provided, the default `Eventarc` service will be returned.
+ *
+ * @returns The default `Eventarc` service if no
+ *   app is provided or the `Eventarc` service associated with the provided
+ *   app.
+ */
+export declare function getEventarc(app?: App): Eventarc;

package/lib/eventarc/index.js

@@ -0,0 +1,64 @@
+/*! firebase-admin v10.3.0 */
+"use strict";
+/*!
+ * @license
+ * Copyright 2022 Google Inc.
+ *
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEventarc = void 0;
+/**
+ * Firebase Eventarc.
+ *
+ * @packageDocumentation
+ */
+var app_1 = require("../app");
+var eventarc_1 = require("./eventarc");
+var eventarc_2 = require("./eventarc");
+Object.defineProperty(exports, "Eventarc", { enumerable: true, get: function () { return eventarc_2.Eventarc; } });
+Object.defineProperty(exports, "Channel", { enumerable: true, get: function () { return eventarc_2.Channel; } });
+/**
+ * Gets the {@link Eventarc} service for the default app or a given app.
+ *
+ * `getEventarc()` can be called with no arguments to access the default
+ * app's `Eventarc` service or as `getEventarc(app)` to access the
+ * `Eventarc` service associated with specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the Eventarc service for the default app
+ * const defaultEventarc = getEventarc();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the Eventarc service for a given app
+ * const otherEventarc = getEventarc(otherApp);
+ * ```
+ *
+ * @param app - Optional app whose `Eventarc` service will be returned.
+ *   If not provided, the default `Eventarc` service will be returned.
+ *
+ * @returns The default `Eventarc` service if no
+ *   app is provided or the `Eventarc` service associated with the provided
+ *   app.
+ */
+function getEventarc(app) {
+    if (typeof app === 'undefined') {
+        app = app_1.getApp();
+    }
+    var firebaseApp = app;
+    return firebaseApp.getOrInitService('eventarc', function (app) { return new eventarc_1.Eventarc(app); });
+}
+exports.getEventarc = getEventarc;

package/lib/firebase-namespace-api.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.2 */
+/*! firebase-admin v10.3.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/firebase-namespace-api.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.2 */
+/*! firebase-admin v10.3.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/firestore/firestore-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.2 */
+/*! firebase-admin v10.3.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/firestore/firestore-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.2 */
+/*! firebase-admin v10.3.0 */
 "use strict";
 /*!
  * @license

package/lib/firestore/firestore-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.2 */
+/*! firebase-admin v10.3.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/firestore/firestore-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.2 */
+/*! firebase-admin v10.3.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/firestore/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.2 */
+/*! firebase-admin v10.3.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/firestore/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.2 */
+/*! firebase-admin v10.3.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/functions/functions-api-client-internal.d.ts

@@ -0,0 +1,32 @@
+/*! firebase-admin v10.3.0 */
+/*!
+ * @license
+ * Copyright 2021 Google Inc.
+ *
+ * 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.
+ */
+import { PrefixedFirebaseError } from '../utils/error';
+export declare const FUNCTIONS_ERROR_CODE_MAPPING: {
+    [key: string]: FunctionsErrorCode;
+};
+export declare type FunctionsErrorCode = 'aborted' | 'invalid-argument' | 'invalid-credential' | 'internal-error' | 'failed-precondition' | 'permission-denied' | 'unauthenticated' | 'not-found' | 'unknown-error';
+/**
+ * Firebase Functions error code structure. This extends PrefixedFirebaseError.
+ *
+ * @param code - The error code.
+ * @param message - The error message.
+ * @constructor
+ */
+export declare class FirebaseFunctionsError extends PrefixedFirebaseError {
+    constructor(code: FunctionsErrorCode, message: string);
+}