@koolbase/core 12.3.0 → 12.4.0

package/dist/cjs/analytics.d.ts

@@ -36,3 +36,9 @@ export declare class KoolbaseAnalytics {
     flush(): Promise<void>;
     dispose(): Promise<void>;
 }
+/**
+ * What Koolbase.analytics is while analytics is off (the default since 12.4.0).
+ * Every call does nothing, and the first says once how to turn it on, so an app
+ * that tracks events without opting in keeps working instead of crashing.
+ */
+export declare function disabledAnalytics(): KoolbaseAnalytics;

package/dist/cjs/analytics.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KoolbaseAnalytics = void 0;
+exports.disabledAnalytics = disabledAnalytics;
 const network_js_1 = require("./network.js");
 const platform_js_1 = require("./platform.js");
 const device_id_js_1 = require("./device-id.js");
@@ -129,3 +130,20 @@ class KoolbaseAnalytics {
     }
 }
 exports.KoolbaseAnalytics = KoolbaseAnalytics;
+/**
+ * What Koolbase.analytics is while analytics is off (the default since 12.4.0).
+ * Every call does nothing, and the first says once how to turn it on, so an app
+ * that tracks events without opting in keeps working instead of crashing.
+ */
+function disabledAnalytics() {
+    let told = false;
+    const noop = () => {
+        if (!told) {
+            told = true;
+            // eslint-disable-next-line no-console
+            console.info('[Koolbase] Analytics is off: it is opt-in since 12.4.0. Pass analyticsEnabled: true to Koolbase.initialize to send events.');
+        }
+        return Promise.resolve();
+    };
+    return new Proxy({}, { get: (_t, prop) => (prop === 'then' ? undefined : noop) });
+}

package/dist/cjs/index.d.ts

@@ -14,7 +14,7 @@ export { KoolbaseFlags } from './flags.js';
 export { KoolbaseFunctions } from './functions.js';
 export { KoolbaseRealtime } from './realtime.js';
 export { KoolbaseStorage } from './storage.js';
-export { KoolbaseAnalytics } from './analytics.js';
+export { KoolbaseAnalytics, disabledAnalytics } from './analytics.js';
 export { KoolbaseFiscal, KoolbaseFiscalError, decodeFiscalResponse, isFiscalized, isPending } from './fiscal.js';
 export type { FiscalIntentResult, FiscalStatus } from './fiscal.js';
 export { KoolbaseMessaging } from './messaging.js';

package/dist/cjs/index.js

@@ -19,7 +19,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.memoryPlatform = exports.getPlatform = exports.setPlatform = exports.RestoreResult = exports.koolbaseSdkVersion = exports.getOrCreateDeviceId = exports.KoolbaseMessaging = exports.isPending = exports.isFiscalized = exports.decodeFiscalResponse = exports.KoolbaseFiscalError = exports.KoolbaseFiscal = exports.KoolbaseAnalytics = exports.KoolbaseStorage = exports.KoolbaseRealtime = exports.KoolbaseFunctions = exports.KoolbaseFlags = exports.KoolbaseDatabase = exports.KoolbaseAuth = void 0;
+exports.memoryPlatform = exports.getPlatform = exports.setPlatform = exports.RestoreResult = exports.koolbaseSdkVersion = exports.getOrCreateDeviceId = exports.KoolbaseMessaging = exports.isPending = exports.isFiscalized = exports.decodeFiscalResponse = exports.KoolbaseFiscalError = exports.KoolbaseFiscal = exports.disabledAnalytics = exports.KoolbaseAnalytics = exports.KoolbaseStorage = exports.KoolbaseRealtime = exports.KoolbaseFunctions = exports.KoolbaseFlags = exports.KoolbaseDatabase = exports.KoolbaseAuth = void 0;
 __exportStar(require("./types.js"), exports);
 __exportStar(require("./errors.js"), exports);
 __exportStar(require("./network.js"), exports);
@@ -44,6 +44,7 @@ var storage_js_1 = require("./storage.js");
 Object.defineProperty(exports, "KoolbaseStorage", { enumerable: true, get: function () { return storage_js_1.KoolbaseStorage; } });
 var analytics_js_1 = require("./analytics.js");
 Object.defineProperty(exports, "KoolbaseAnalytics", { enumerable: true, get: function () { return analytics_js_1.KoolbaseAnalytics; } });
+Object.defineProperty(exports, "disabledAnalytics", { enumerable: true, get: function () { return analytics_js_1.disabledAnalytics; } });
 var fiscal_js_1 = require("./fiscal.js");
 Object.defineProperty(exports, "KoolbaseFiscal", { enumerable: true, get: function () { return fiscal_js_1.KoolbaseFiscal; } });
 Object.defineProperty(exports, "KoolbaseFiscalError", { enumerable: true, get: function () { return fiscal_js_1.KoolbaseFiscalError; } });

package/dist/cjs/network.d.ts

@@ -11,6 +11,8 @@
  */
 export declare class KoolbaseNetworkError extends TypeError {
     code: string;
+    /** A short message that is safe to show to people; `message` is for developers. */
+    readonly userMessage = "We can't connect right now. Check your connection and try again.";
     readonly url: string;
     readonly origin?: string;
     constructor(url: string, cause: unknown);

package/dist/cjs/network.js

@@ -31,6 +31,8 @@ class KoolbaseNetworkError extends TypeError {
             : ' Check the network connection and the configured base URL.';
         super(message);
         this.code = 'network_error';
+        /** A short message that is safe to show to people; `message` is for developers. */
+        this.userMessage = "We can't connect right now. Check your connection and try again.";
         this.name = 'KoolbaseNetworkError';
         this.url = url;
         this.origin = origin;

package/dist/esm/analytics.d.ts

@@ -36,3 +36,9 @@ export declare class KoolbaseAnalytics {
     flush(): Promise<void>;
     dispose(): Promise<void>;
 }
+/**
+ * What Koolbase.analytics is while analytics is off (the default since 12.4.0).
+ * Every call does nothing, and the first says once how to turn it on, so an app
+ * that tracks events without opting in keeps working instead of crashing.
+ */
+export declare function disabledAnalytics(): KoolbaseAnalytics;

package/dist/esm/analytics.js

@@ -125,3 +125,20 @@ export class KoolbaseAnalytics {
         await this.flush();
     }
 }
+/**
+ * What Koolbase.analytics is while analytics is off (the default since 12.4.0).
+ * Every call does nothing, and the first says once how to turn it on, so an app
+ * that tracks events without opting in keeps working instead of crashing.
+ */
+export function disabledAnalytics() {
+    let told = false;
+    const noop = () => {
+        if (!told) {
+            told = true;
+            // eslint-disable-next-line no-console
+            console.info('[Koolbase] Analytics is off: it is opt-in since 12.4.0. Pass analyticsEnabled: true to Koolbase.initialize to send events.');
+        }
+        return Promise.resolve();
+    };
+    return new Proxy({}, { get: (_t, prop) => (prop === 'then' ? undefined : noop) });
+}

package/dist/esm/index.d.ts

@@ -14,7 +14,7 @@ export { KoolbaseFlags } from './flags.js';
 export { KoolbaseFunctions } from './functions.js';
 export { KoolbaseRealtime } from './realtime.js';
 export { KoolbaseStorage } from './storage.js';
-export { KoolbaseAnalytics } from './analytics.js';
+export { KoolbaseAnalytics, disabledAnalytics } from './analytics.js';
 export { KoolbaseFiscal, KoolbaseFiscalError, decodeFiscalResponse, isFiscalized, isPending } from './fiscal.js';
 export type { FiscalIntentResult, FiscalStatus } from './fiscal.js';
 export { KoolbaseMessaging } from './messaging.js';

package/dist/esm/index.js

@@ -19,7 +19,7 @@ export { KoolbaseFlags } from './flags.js';
 export { KoolbaseFunctions } from './functions.js';
 export { KoolbaseRealtime } from './realtime.js';
 export { KoolbaseStorage } from './storage.js';
-export { KoolbaseAnalytics } from './analytics.js';
+export { KoolbaseAnalytics, disabledAnalytics } from './analytics.js';
 export { KoolbaseFiscal, KoolbaseFiscalError, decodeFiscalResponse, isFiscalized, isPending } from './fiscal.js';
 export { KoolbaseMessaging } from './messaging.js';
 export { getOrCreateDeviceId } from './device-id.js';

package/dist/esm/network.d.ts

@@ -11,6 +11,8 @@
  */
 export declare class KoolbaseNetworkError extends TypeError {
     code: string;
+    /** A short message that is safe to show to people; `message` is for developers. */
+    readonly userMessage = "We can't connect right now. Check your connection and try again.";
     readonly url: string;
     readonly origin?: string;
     constructor(url: string, cause: unknown);

package/dist/esm/network.js

@@ -27,6 +27,8 @@ export class KoolbaseNetworkError extends TypeError {
             : ' Check the network connection and the configured base URL.';
         super(message);
         this.code = 'network_error';
+        /** A short message that is safe to show to people; `message` is for developers. */
+        this.userMessage = "We can't connect right now. Check your connection and try again.";
         this.name = 'KoolbaseNetworkError';
         this.url = url;
         this.origin = origin;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@koolbase/core",
-  "version": "12.3.0",
-  "description": "Koolbase SDK core — shared behaviour behind @koolbase/react-native and @koolbase/js. Install one of those, not this.",
+  "version": "12.4.0",
+  "description": "Koolbase SDK core \u2014 shared behaviour behind @koolbase/react-native and @koolbase/js. Install one of those, not this.",
   "main": "./dist/cjs/index.js",
   "types": "./dist/esm/index.d.ts",
   "files": [