@scalar/api-reference 1.52.2 → 1.52.4

package/dist/plugins/posthog/index.d.ts

@@ -0,0 +1,16 @@
+import { type PostHogConfig } from '@scalar/api-client/plugins/posthog';
+import type { ApiReferencePlugin } from '../plugin-manager.js';
+export type { PostHogConfig };
+/**
+ * PostHog analytics plugin for the API Reference.
+ *
+ * Loading this plugin opts in to analytics for both the API Reference
+ * and the embedded API Client (tracked as separate products).
+ *
+ * Respects the `telemetry` configuration option — when set to `false`,
+ * capturing is disabled. Reacts dynamically to config changes at runtime.
+ *
+ * If the plugin is not loaded, no tracking occurs.
+ */
+export declare const PostHogPlugin: (config: PostHogConfig) => ApiReferencePlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/plugins/posthog/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/posthog/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,aAAa,EAAE,MAAM,oCAAoC,CAAA;AAI5F,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAE3D,YAAY,EAAE,aAAa,EAAE,CAAA;AAE7B;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,GAAI,QAAQ,aAAa,KAAG,kBAuDrD,CAAA"}

package/dist/plugins/posthog/index.js

@@ -0,0 +1,54 @@
+import { PostHogClientPlugin } from "@scalar/api-client/plugins/posthog";
+import ph from "posthog-js";
+//#region src/plugins/posthog/index.ts
+/**
+* PostHog analytics plugin for the API Reference.
+*
+* Loading this plugin opts in to analytics for both the API Reference
+* and the embedded API Client (tracked as separate products).
+*
+* Respects the `telemetry` configuration option — when set to `false`,
+* capturing is disabled. Reacts dynamically to config changes at runtime.
+*
+* If the plugin is not loaded, no tracking occurs.
+*/
+var PostHogPlugin = (config) => {
+	let posthog = null;
+	const clientPlugin = PostHogClientPlugin(config);
+	return () => ({
+		name: "posthog",
+		extensions: [],
+		apiClientPlugins: [clientPlugin],
+		hooks: {
+			onInit({ config: referenceConfig }) {
+				if (typeof window === "undefined") return;
+				const instance = ph.init(config.apiKey, {
+					api_host: config.apiHost,
+					...config.uiHost ? { ui_host: config.uiHost } : {},
+					...config.defaults ? { defaults: config.defaults } : {},
+					opt_out_capturing_by_default: true
+				}, "scalar-api-reference");
+				if (instance) {
+					posthog = instance;
+					posthog.register({ product: "api-reference" });
+					if (referenceConfig.telemetry !== false) posthog.opt_in_capturing();
+				}
+				clientPlugin.lifecycle?.onInit?.({ config: referenceConfig });
+			},
+			onConfigChange({ config: referenceConfig }) {
+				if (posthog) if (referenceConfig.telemetry === false) posthog.opt_out_capturing();
+				else posthog.opt_in_capturing();
+				clientPlugin.lifecycle?.onConfigChange?.({ config: referenceConfig });
+			},
+			onDestroy() {
+				posthog?.reset();
+				posthog = null;
+				clientPlugin.lifecycle?.onDestroy?.();
+			}
+		}
+	});
+};
+//#endregion
+export { PostHogPlugin };
+
+//# sourceMappingURL=index.js.map

package/dist/plugins/posthog/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../../src/plugins/posthog/index.ts"],"sourcesContent":["import { PostHogClientPlugin, type PostHogConfig } from '@scalar/api-client/plugins/posthog'\nimport type { PostHog } from 'posthog-js'\nimport ph from 'posthog-js'\n\nimport type { ApiReferencePlugin } from '../plugin-manager'\n\nexport type { PostHogConfig }\n\n/**\n * PostHog analytics plugin for the API Reference.\n *\n * Loading this plugin opts in to analytics for both the API Reference\n * and the embedded API Client (tracked as separate products).\n *\n * Respects the `telemetry` configuration option — when set to `false`,\n * capturing is disabled. Reacts dynamically to config changes at runtime.\n *\n * If the plugin is not loaded, no tracking occurs.\n */\nexport const PostHogPlugin = (config: PostHogConfig): ApiReferencePlugin => {\n  let posthog: PostHog | null = null\n  const clientPlugin = PostHogClientPlugin(config)\n\n  return () => ({\n    name: 'posthog',\n    extensions: [],\n    apiClientPlugins: [clientPlugin],\n    hooks: {\n      onInit({ config: referenceConfig }) {\n        if (typeof window === 'undefined') {\n          return\n        }\n\n        const instance = ph.init(\n          config.apiKey,\n          {\n            api_host: config.apiHost,\n            ...(config.uiHost ? { ui_host: config.uiHost } : {}),\n            ...(config.defaults ? { defaults: config.defaults } : {}),\n            opt_out_capturing_by_default: true,\n          },\n          'scalar-api-reference',\n        )\n\n        if (instance) {\n          posthog = instance\n          posthog.register({ product: 'api-reference' })\n\n          if (referenceConfig.telemetry !== false) {\n            posthog.opt_in_capturing()\n          }\n        }\n\n        clientPlugin.lifecycle?.onInit?.({ config: referenceConfig })\n      },\n      onConfigChange({ config: referenceConfig }) {\n        if (posthog) {\n          if (referenceConfig.telemetry === false) {\n            posthog.opt_out_capturing()\n          } else {\n            posthog.opt_in_capturing()\n          }\n        }\n\n        clientPlugin.lifecycle?.onConfigChange?.({ config: referenceConfig })\n      },\n      onDestroy() {\n        posthog?.reset()\n        posthog = null\n\n        clientPlugin.lifecycle?.onDestroy?.()\n      },\n    },\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;AAmBA,IAAa,iBAAiB,WAA8C;CAC1E,IAAI,UAA0B;CAC9B,MAAM,eAAe,oBAAoB,OAAO;AAEhD,eAAc;EACZ,MAAM;EACN,YAAY,EAAE;EACd,kBAAkB,CAAC,aAAa;EAChC,OAAO;GACL,OAAO,EAAE,QAAQ,mBAAmB;AAClC,QAAI,OAAO,WAAW,YACpB;IAGF,MAAM,WAAW,GAAG,KAClB,OAAO,QACP;KACE,UAAU,OAAO;KACjB,GAAI,OAAO,SAAS,EAAE,SAAS,OAAO,QAAQ,GAAG,EAAE;KACnD,GAAI,OAAO,WAAW,EAAE,UAAU,OAAO,UAAU,GAAG,EAAE;KACxD,8BAA8B;KAC/B,EACD,uBACD;AAED,QAAI,UAAU;AACZ,eAAU;AACV,aAAQ,SAAS,EAAE,SAAS,iBAAiB,CAAC;AAE9C,SAAI,gBAAgB,cAAc,MAChC,SAAQ,kBAAkB;;AAI9B,iBAAa,WAAW,SAAS,EAAE,QAAQ,iBAAiB,CAAC;;GAE/D,eAAe,EAAE,QAAQ,mBAAmB;AAC1C,QAAI,QACF,KAAI,gBAAgB,cAAc,MAChC,SAAQ,mBAAmB;QAE3B,SAAQ,kBAAkB;AAI9B,iBAAa,WAAW,iBAAiB,EAAE,QAAQ,iBAAiB,CAAC;;GAEvE,YAAY;AACV,aAAS,OAAO;AAChB,cAAU;AAEV,iBAAa,WAAW,aAAa;;GAExC;EACF"}