@firebase/functions - npm Package Compare versions

Comparing version 0.11.8-canary.813b9fad6 to 0.11.8-canary.8fb044e8d

dist/esm-node/index.node.esm.js

@@ -175,6 +175,12 @@ import { _registerComponent, registerVersion, _getProvider, getApp } from '@firebase/app';
 /**
- * An explicit error that can be thrown from a handler to send an error to the
- * client that called the function.
+ * An error returned by the Firebase Functions client SDK.
+ *
+ * See {@link FunctionsErrorCode} for full documentation of codes.
+ *
+ * @public
  */
 class FunctionsError extends FirebaseError {
+    /**
+     * Constructs a new instance of the `FunctionsError` class.
+     */
     constructor(
@@ -187,3 +193,3 @@ /**
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
@@ -193,2 +199,5 @@ details) {
         this.details = details;
+        // Since the FirebaseError constructor sets the prototype of `this` to FirebaseError.prototype,
+        // we also have to do it in all subclasses to allow for correct `instanceof` checks.
+        Object.setPrototypeOf(this, FunctionsError.prototype);
     }
@@ -612,3 +621,3 @@ }
 const name = "@firebase/functions";
-const version = "0.11.8-canary.813b9fad6";
+const version = "0.11.8-canary.8fb044e8d";
 
@@ -734,3 +743,3 @@ /**
 
-export { connectFunctionsEmulator, getFunctions, httpsCallable, httpsCallableFromURL };
+export { FunctionsError, connectFunctionsEmulator, getFunctions, httpsCallable, httpsCallableFromURL };
 //# sourceMappingURL=index.node.esm.js.map

dist/esm-node/src/api.d.ts

@@ -19,2 +19,3 @@ /**
 import { Functions, HttpsCallableOptions, HttpsCallable } from './public-types';
+export { FunctionsError } from './error';
 export * from './public-types';
@@ -21,0 +22,0 @@ /**

dist/esm-node/src/error.d.ts

@@ -21,10 +21,16 @@ /**
 /**
- * An explicit error that can be thrown from a handler to send an error to the
- * client that called the function.
+ * An error returned by the Firebase Functions client SDK.
+ *
+ * See {@link FunctionsErrorCode} for full documentation of codes.
+ *
+ * @public
  */
 export declare class FunctionsError extends FirebaseError {
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
     readonly details?: unknown;
+    /**
+     * Constructs a new instance of the `FunctionsError` class.
+     */
     constructor(
@@ -37,3 +43,3 @@ /**
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
@@ -40,0 +46,0 @@ details?: unknown);

dist/esm-node/src/public-types.d.ts

@@ -18,3 +18,2 @@ /**
 import { FirebaseApp } from '@firebase/app';
-import { FirebaseError } from '@firebase/util';
 /**
@@ -120,17 +119,2 @@ * An `HttpsCallableResult` wraps a single result from a function call.
 export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;
-/**
- * An error returned by the Firebase Functions client SDK.
- * @public
- */
-export interface FunctionsError extends FirebaseError {
-    /**
-     * A standard error code that will be returned to the client. This also
-     * determines the HTTP status code of the response, as defined in code.proto.
-     */
-    readonly code: FunctionsErrorCode;
-    /**
-     * Extra data to be converted to JSON and included in the error response.
-     */
-    readonly details?: unknown;
-}
 declare module '@firebase/component' {
@@ -137,0 +121,0 @@ interface NameServiceMapping {

dist/functions-public.d.ts

@@ -44,14 +44,25 @@ /**
  * An error returned by the Firebase Functions client SDK.
+ *
+ * See {@link FunctionsErrorCode} for full documentation of codes.
+ *
  * @public
  */
-export declare interface FunctionsError extends FirebaseError {
+export declare class FunctionsError extends FirebaseError {
     /**
+     * Additional details to be converted to JSON and included in the error response.
+     */
+    readonly details?: unknown;
+    /**
+     * Constructs a new instance of the `FunctionsError` class.
+     */
+    constructor(
+    /**
      * A standard error code that will be returned to the client. This also
      * determines the HTTP status code of the response, as defined in code.proto.
      */
-    readonly code: FunctionsErrorCode;
+    code: FunctionsErrorCodeCore, message?: string, 
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
-    readonly details?: unknown;
+    details?: unknown);
 }
@@ -58,0 +69,0 @@

dist/functions.d.ts

@@ -44,14 +44,25 @@ /**
  * An error returned by the Firebase Functions client SDK.
+ *
+ * See {@link FunctionsErrorCode} for full documentation of codes.
+ *
  * @public
  */
-export declare interface FunctionsError extends FirebaseError {
+export declare class FunctionsError extends FirebaseError {
     /**
+     * Additional details to be converted to JSON and included in the error response.
+     */
+    readonly details?: unknown;
+    /**
+     * Constructs a new instance of the `FunctionsError` class.
+     */
+    constructor(
+    /**
      * A standard error code that will be returned to the client. This also
      * determines the HTTP status code of the response, as defined in code.proto.
      */
-    readonly code: FunctionsErrorCode;
+    code: FunctionsErrorCodeCore, message?: string, 
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
-    readonly details?: unknown;
+    details?: unknown);
 }
@@ -58,0 +69,0 @@

dist/index.cjs.js

@@ -178,6 +178,12 @@ 'use strict';
 /**
- * An explicit error that can be thrown from a handler to send an error to the
- * client that called the function.
+ * An error returned by the Firebase Functions client SDK.
+ *
+ * See {@link FunctionsErrorCode} for full documentation of codes.
+ *
+ * @public
  */
 class FunctionsError extends util.FirebaseError {
+    /**
+     * Constructs a new instance of the `FunctionsError` class.
+     */
     constructor(
@@ -190,3 +196,3 @@ /**
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
@@ -196,2 +202,5 @@ details) {
         this.details = details;
+        // Since the FirebaseError constructor sets the prototype of `this` to FirebaseError.prototype,
+        // we also have to do it in all subclasses to allow for correct `instanceof` checks.
+        Object.setPrototypeOf(this, FunctionsError.prototype);
     }
@@ -615,3 +624,3 @@ }
 const name = "@firebase/functions";
-const version = "0.11.8-canary.813b9fad6";
+const version = "0.11.8-canary.8fb044e8d";
 
@@ -725,2 +734,3 @@ /**
 
+exports.FunctionsError = FunctionsError;
 exports.connectFunctionsEmulator = connectFunctionsEmulator;
@@ -727,0 +737,0 @@ exports.getFunctions = getFunctions;

dist/index.esm.js

@@ -175,7 +175,13 @@ import { _registerComponent, registerVersion, getApp, _getProvider } from '@firebase/app';
 /**
- * An explicit error that can be thrown from a handler to send an error to the
- * client that called the function.
+ * An error returned by the Firebase Functions client SDK.
+ *
+ * See {@link FunctionsErrorCode} for full documentation of codes.
+ *
+ * @public
  */
 var FunctionsError = /** @class */ (function (_super) {
     __extends(FunctionsError, _super);
+    /**
+     * Constructs a new instance of the `FunctionsError` class.
+     */
     function FunctionsError(
@@ -188,3 +194,3 @@ /**
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
@@ -194,2 +200,5 @@ details) {
         _this.details = details;
+        // Since the FirebaseError constructor sets the prototype of `this` to FirebaseError.prototype,
+        // we also have to do it in all subclasses to allow for correct `instanceof` checks.
+        Object.setPrototypeOf(_this, FunctionsError.prototype);
         return _this;
@@ -694,3 +703,3 @@ }
 var name = "@firebase/functions";
-var version = "0.11.8-canary.813b9fad6";
+var version = "0.11.8-canary.8fb044e8d";
 
@@ -807,3 +816,3 @@ /**
 
-export { connectFunctionsEmulator, getFunctions, httpsCallable, httpsCallableFromURL };
+export { FunctionsError, connectFunctionsEmulator, getFunctions, httpsCallable, httpsCallableFromURL };
 //# sourceMappingURL=index.esm.js.map

dist/index.esm2017.js

@@ -174,6 +174,12 @@ import { _registerComponent, registerVersion, _getProvider, getApp } from '@firebase/app';
 /**
- * An explicit error that can be thrown from a handler to send an error to the
- * client that called the function.
+ * An error returned by the Firebase Functions client SDK.
+ *
+ * See {@link FunctionsErrorCode} for full documentation of codes.
+ *
+ * @public
  */
 class FunctionsError extends FirebaseError {
+    /**
+     * Constructs a new instance of the `FunctionsError` class.
+     */
     constructor(
@@ -186,3 +192,3 @@ /**
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
@@ -192,2 +198,5 @@ details) {
         this.details = details;
+        // Since the FirebaseError constructor sets the prototype of `this` to FirebaseError.prototype,
+        // we also have to do it in all subclasses to allow for correct `instanceof` checks.
+        Object.setPrototypeOf(this, FunctionsError.prototype);
     }
@@ -611,3 +620,3 @@ }
 const name = "@firebase/functions";
-const version = "0.11.8-canary.813b9fad6";
+const version = "0.11.8-canary.8fb044e8d";
 
@@ -721,3 +730,3 @@ /**
 
-export { connectFunctionsEmulator, getFunctions, httpsCallable, httpsCallableFromURL };
+export { FunctionsError, connectFunctionsEmulator, getFunctions, httpsCallable, httpsCallableFromURL };
 //# sourceMappingURL=index.esm2017.js.map

dist/index.node.cjs.js

@@ -180,7 +180,13 @@ 'use strict';
 /**
- * An explicit error that can be thrown from a handler to send an error to the
- * client that called the function.
+ * An error returned by the Firebase Functions client SDK.
+ *
+ * See {@link FunctionsErrorCode} for full documentation of codes.
+ *
+ * @public
  */
 var FunctionsError = /** @class */ (function (_super) {
     tslib.__extends(FunctionsError, _super);
+    /**
+     * Constructs a new instance of the `FunctionsError` class.
+     */
     function FunctionsError(
@@ -193,3 +199,3 @@ /**
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
@@ -199,2 +205,5 @@ details) {
         _this.details = details;
+        // Since the FirebaseError constructor sets the prototype of `this` to FirebaseError.prototype,
+        // we also have to do it in all subclasses to allow for correct `instanceof` checks.
+        Object.setPrototypeOf(_this, FunctionsError.prototype);
         return _this;
@@ -699,3 +708,3 @@ }
 var name = "@firebase/functions";
-var version = "0.11.8-canary.813b9fad6";
+var version = "0.11.8-canary.8fb044e8d";
 
@@ -824,2 +833,3 @@ /**
 
+exports.FunctionsError = FunctionsError;
 exports.connectFunctionsEmulator = connectFunctionsEmulator;
@@ -826,0 +836,0 @@ exports.getFunctions = getFunctions;

dist/src/api.d.ts

@@ -19,2 +19,3 @@ /**
 import { Functions, HttpsCallableOptions, HttpsCallable } from './public-types';
+export { FunctionsError } from './error';
 export * from './public-types';
@@ -21,0 +22,0 @@ /**

dist/src/error.d.ts

@@ -21,10 +21,16 @@ /**
 /**
- * An explicit error that can be thrown from a handler to send an error to the
- * client that called the function.
+ * An error returned by the Firebase Functions client SDK.
+ *
+ * See {@link FunctionsErrorCode} for full documentation of codes.
+ *
+ * @public
  */
 export declare class FunctionsError extends FirebaseError {
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
     readonly details?: unknown;
+    /**
+     * Constructs a new instance of the `FunctionsError` class.
+     */
     constructor(
@@ -37,3 +43,3 @@ /**
     /**
-     * Extra data to be converted to JSON and included in the error response.
+     * Additional details to be converted to JSON and included in the error response.
      */
@@ -40,0 +46,0 @@ details?: unknown);

dist/src/public-types.d.ts

@@ -18,3 +18,2 @@ /**
 import { FirebaseApp } from '@firebase/app';
-import { FirebaseError } from '@firebase/util';
 /**
@@ -120,17 +119,2 @@ * An `HttpsCallableResult` wraps a single result from a function call.
 export declare type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;
-/**
- * An error returned by the Firebase Functions client SDK.
- * @public
- */
-export interface FunctionsError extends FirebaseError {
-    /**
-     * A standard error code that will be returned to the client. This also
-     * determines the HTTP status code of the response, as defined in code.proto.
-     */
-    readonly code: FunctionsErrorCode;
-    /**
-     * Extra data to be converted to JSON and included in the error response.
-     */
-    readonly details?: unknown;
-}
 declare module '@firebase/component' {
@@ -137,0 +121,0 @@ interface NameServiceMapping {

package.json

 {
   "name": "@firebase/functions",
-  "version": "0.11.8-canary.813b9fad6",
+  "version": "0.11.8-canary.8fb044e8d",
   "description": "",
@@ -51,6 +51,6 @@ "author": "Firebase <[e-mail]> (https://firebase.google.com/)",
   "peerDependencies": {
-    "@firebase/app": "0.10.13-canary.813b9fad6"
+    "@firebase/app": "0.10.13-canary.8fb044e8d"
   },
   "devDependencies": {
-    "@firebase/app": "0.10.13-canary.813b9fad6",
+    "@firebase/app": "0.10.13-canary.8fb044e8d",
     "rollup": "2.79.1",
@@ -71,7 +71,7 @@ "@rollup/plugin-json": "4.1.0",
   "dependencies": {
-    "@firebase/component": "0.6.9-canary.813b9fad6",
-    "@firebase/messaging-interop-types": "0.2.2-canary.813b9fad6",
-    "@firebase/auth-interop-types": "0.2.3-canary.813b9fad6",
-    "@firebase/app-check-interop-types": "0.3.2-canary.813b9fad6",
-    "@firebase/util": "1.10.0-canary.813b9fad6",
+    "@firebase/component": "0.6.9-canary.8fb044e8d",
+    "@firebase/messaging-interop-types": "0.2.2-canary.8fb044e8d",
+    "@firebase/auth-interop-types": "0.2.3-canary.8fb044e8d",
+    "@firebase/app-check-interop-types": "0.3.2-canary.8fb044e8d",
+    "@firebase/util": "1.10.0-canary.8fb044e8d",
     "undici": "6.19.7",
@@ -78,0 +78,0 @@ "tslib": "^2.1.0"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

436034

increased by1.02%

Lines of code

5008

increased by1.03%

Dependency changes

• + Added@firebase/app@0.10.13-canary.8fb044e8d(transitive)

• + Added@firebase/app-check-interop-types@0.3.2-canary.8fb044e8d(transitive)

• + Added@firebase/auth-interop-types@0.2.3-canary.8fb044e8d(transitive)

• + Added@firebase/component@0.6.9-canary.8fb044e8d(transitive)

• + Added@firebase/logger@0.4.2-canary.8fb044e8d(transitive)

• + Added@firebase/messaging-interop-types@0.2.2-canary.8fb044e8d(transitive)

• + Added@firebase/util@1.10.0-canary.8fb044e8d(transitive)

• - Removed@firebase/app@0.10.13-canary.813b9fad6(transitive)

• - Removed@firebase/app-check-interop-types@0.3.2-canary.813b9fad6(transitive)

• - Removed@firebase/auth-interop-types@0.2.3-canary.813b9fad6(transitive)

• - Removed@firebase/component@0.6.9-canary.813b9fad6(transitive)

• - Removed@firebase/logger@0.4.2-canary.813b9fad6(transitive)

• - Removed@firebase/messaging-interop-types@0.2.2-canary.813b9fad6(transitive)

• - Removed@firebase/util@1.10.0-canary.813b9fad6(transitive)

• Updated@firebase/app-check-interop-types@0.3.2-canary.8fb044e8d

• Updated@firebase/auth-interop-types@0.2.3-canary.8fb044e8d

• Updated@firebase/component@0.6.9-canary.8fb044e8d

• Updated@firebase/messaging-interop-types@0.2.2-canary.8fb044e8d

• Updated@firebase/util@1.10.0-canary.8fb044e8d