@scalar/api-client 2.43.0 → 3.1.0

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

@@ -0,0 +1,23 @@
+import type { ClientPlugin } from '@scalar/oas-utils/helpers';
+import type { ConfigDefaults } from 'posthog-js';
+export type PostHogConfig = {
+    /** Your PostHog project API key */
+    apiKey: string;
+    /** The PostHog API host URL */
+    apiHost: string;
+    /** The PostHog UI host URL (for session recordings, surveys, etc.) */
+    uiHost?: string;
+    /** PostHog defaults version identifier */
+    defaults?: ConfigDefaults;
+};
+/**
+ * PostHog analytics plugin for the API Client.
+ *
+ * Loading this plugin opts in to analytics. If the plugin is not loaded,
+ * no tracking occurs.
+ *
+ * Respects the `telemetry` configuration option — when set to `false`,
+ * capturing is disabled. Reacts dynamically to config changes at runtime.
+ */
+export declare const PostHogClientPlugin: (config: PostHogConfig) => ClientPlugin;
+//# 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,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAW,MAAM,YAAY,CAAA;AAGzD,MAAM,MAAM,aAAa,GAAG;IAC1B,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,cAAc,CAAA;CAC1B,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,GAAI,QAAQ,aAAa,KAAG,YA4D3D,CAAA"}

package/dist/plugins/posthog/index.js

@@ -0,0 +1,58 @@
+import ph from "posthog-js";
+//#region src/plugins/posthog/index.ts
+/**
+* PostHog analytics plugin for the API Client.
+*
+* Loading this plugin opts in to analytics. If the plugin is not loaded,
+* no tracking occurs.
+*
+* Respects the `telemetry` configuration option — when set to `false`,
+* capturing is disabled. Reacts dynamically to config changes at runtime.
+*/
+var PostHogClientPlugin = (config) => {
+	let posthog = null;
+	return {
+		on: {
+			"hooks:on:request:sent": () => posthog?.capture("hooks:on:request:sent"),
+			"operation:create:operation": () => posthog?.capture("operation:create:operation"),
+			"operation:delete:operation": () => posthog?.capture("operation:delete:operation"),
+			"document:create:empty-document": () => posthog?.capture("document:create:empty-document"),
+			"document:delete:document": () => posthog?.capture("document:delete:document"),
+			"tag:create:tag": () => posthog?.capture("tag:create:tag"),
+			"server:add:server": () => posthog?.capture("server:add:server"),
+			"auth:update:selected-security-schemes": () => posthog?.capture("auth:update:selected-security-schemes"),
+			"environment:upsert:environment": () => posthog?.capture("environment:upsert:environment"),
+			"ui:open:client-modal": () => posthog?.capture("ui:open:client-modal"),
+			"ui:download:document": () => posthog?.capture("ui:download:document")
+		},
+		lifecycle: {
+			onInit(context) {
+				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-client");
+				if (instance) {
+					posthog = instance;
+					posthog.register({ product: "api-client" });
+					if (context?.config.telemetry !== false) posthog.opt_in_capturing();
+				}
+			},
+			onConfigChange(context) {
+				if (!posthog) return;
+				if (context.config.telemetry === false) posthog.opt_out_capturing();
+				else posthog.opt_in_capturing();
+			},
+			onDestroy() {
+				posthog?.reset();
+				posthog = null;
+			}
+		}
+	};
+};
+//#endregion
+export { PostHogClientPlugin };
+
+//# 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 type { ClientPlugin } from '@scalar/oas-utils/helpers'\nimport type { ConfigDefaults, PostHog } from 'posthog-js'\nimport ph from 'posthog-js'\n\nexport type PostHogConfig = {\n  /** Your PostHog project API key */\n  apiKey: string\n  /** The PostHog API host URL */\n  apiHost: string\n  /** The PostHog UI host URL (for session recordings, surveys, etc.) */\n  uiHost?: string\n  /** PostHog defaults version identifier */\n  defaults?: ConfigDefaults\n}\n\n/**\n * PostHog analytics plugin for the API Client.\n *\n * Loading this plugin opts in to analytics. If the plugin is not loaded,\n * no tracking occurs.\n *\n * Respects the `telemetry` configuration option — when set to `false`,\n * capturing is disabled. Reacts dynamically to config changes at runtime.\n */\nexport const PostHogClientPlugin = (config: PostHogConfig): ClientPlugin => {\n  let posthog: PostHog | null = null\n\n  return {\n    on: {\n      'hooks:on:request:sent': () => posthog?.capture('hooks:on:request:sent'),\n      'operation:create:operation': () => posthog?.capture('operation:create:operation'),\n      'operation:delete:operation': () => posthog?.capture('operation:delete:operation'),\n      'document:create:empty-document': () => posthog?.capture('document:create:empty-document'),\n      'document:delete:document': () => posthog?.capture('document:delete:document'),\n      'tag:create:tag': () => posthog?.capture('tag:create:tag'),\n      'server:add:server': () => posthog?.capture('server:add:server'),\n      'auth:update:selected-security-schemes': () => posthog?.capture('auth:update:selected-security-schemes'),\n      'environment:upsert:environment': () => posthog?.capture('environment:upsert:environment'),\n      'ui:open:client-modal': () => posthog?.capture('ui:open:client-modal'),\n      'ui:download:document': () => posthog?.capture('ui:download:document'),\n    },\n    lifecycle: {\n      onInit(context) {\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-client',\n        )\n\n        if (instance) {\n          posthog = instance\n          posthog.register({ product: 'api-client' })\n\n          if (context?.config.telemetry !== false) {\n            posthog.opt_in_capturing()\n          }\n        }\n      },\n      onConfigChange(context) {\n        if (!posthog) {\n          return\n        }\n\n        if (context.config.telemetry === false) {\n          posthog.opt_out_capturing()\n        } else {\n          posthog.opt_in_capturing()\n        }\n      },\n      onDestroy() {\n        posthog?.reset()\n        posthog = null\n      },\n    },\n  }\n}\n"],"mappings":";;;;;;;;;;;AAwBA,IAAa,uBAAuB,WAAwC;CAC1E,IAAI,UAA0B;AAE9B,QAAO;EACL,IAAI;GACF,+BAA+B,SAAS,QAAQ,wBAAwB;GACxE,oCAAoC,SAAS,QAAQ,6BAA6B;GAClF,oCAAoC,SAAS,QAAQ,6BAA6B;GAClF,wCAAwC,SAAS,QAAQ,iCAAiC;GAC1F,kCAAkC,SAAS,QAAQ,2BAA2B;GAC9E,wBAAwB,SAAS,QAAQ,iBAAiB;GAC1D,2BAA2B,SAAS,QAAQ,oBAAoB;GAChE,+CAA+C,SAAS,QAAQ,wCAAwC;GACxG,wCAAwC,SAAS,QAAQ,iCAAiC;GAC1F,8BAA8B,SAAS,QAAQ,uBAAuB;GACtE,8BAA8B,SAAS,QAAQ,uBAAuB;GACvE;EACD,WAAW;GACT,OAAO,SAAS;AACd,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,oBACD;AAED,QAAI,UAAU;AACZ,eAAU;AACV,aAAQ,SAAS,EAAE,SAAS,cAAc,CAAC;AAE3C,SAAI,SAAS,OAAO,cAAc,MAChC,SAAQ,kBAAkB;;;GAIhC,eAAe,SAAS;AACtB,QAAI,CAAC,QACH;AAGF,QAAI,QAAQ,OAAO,cAAc,MAC/B,SAAQ,mBAAmB;QAE3B,SAAQ,kBAAkB;;GAG9B,YAAY;AACV,aAAS,OAAO;AAChB,cAAU;;GAEb;EACF"}