@contractspec/example.integration-posthog 1.57.0 → 1.58.0

package/dist/node/run.js

@@ -0,0 +1,280 @@
+// src/posthog.ts
+import { PosthogAnalyticsProvider } from "@contractspec/integration.providers-impls/impls/posthog";
+async function runPosthogExampleFromEnv() {
+  const mode = resolvePosthogMode();
+  const dryRun = resolveBooleanEnv("CONTRACTSPEC_POSTHOG_DRY_RUN", true);
+  const allowWrites = resolveBooleanEnv("CONTRACTSPEC_POSTHOG_ALLOW_WRITES", false);
+  const output = { mode, dryRun, allowWrites };
+  if (dryRun) {
+    if (mode === "capture" || mode === "all") {
+      output.capture = buildCapturePreview();
+    }
+    if (mode === "query" || mode === "all") {
+      output.query = { query: buildHogQLQuery() };
+    }
+    if (mode === "request" || mode === "all") {
+      output.request = buildRequestPreview();
+    }
+    if (mode === "read" || mode === "all") {
+      output.read = buildReadPreview();
+    }
+    if (process.env.POSTHOG_MCP_URL) {
+      output.mcp = buildMcpPreview();
+    }
+    return output;
+  }
+  const provider = createProviderFromEnv();
+  if (mode === "capture" || mode === "all") {
+    output.capture = await runCapture(provider, allowWrites);
+  }
+  if (mode === "query" || mode === "all") {
+    output.query = await runHogQLQuery(provider);
+  }
+  if (mode === "request" || mode === "all") {
+    output.request = await runApiRequests(provider, allowWrites);
+  }
+  if (mode === "read" || mode === "all") {
+    output.read = await runReadOperations(provider);
+  }
+  if (process.env.POSTHOG_MCP_URL) {
+    output.mcp = await runMcpToolCall(provider);
+  }
+  return output;
+}
+function resolvePosthogMode() {
+  const raw = (process.env.CONTRACTSPEC_POSTHOG_MODE ?? "all").toLowerCase();
+  if (raw === "capture" || raw === "query" || raw === "request" || raw === "read" || raw === "all") {
+    return raw;
+  }
+  throw new Error(`Unsupported CONTRACTSPEC_POSTHOG_MODE: ${raw}. Use capture, query, request, read, or all.`);
+}
+function createProviderFromEnv() {
+  return new PosthogAnalyticsProvider({
+    host: process.env.POSTHOG_HOST,
+    projectId: process.env.POSTHOG_PROJECT_ID,
+    projectApiKey: process.env.POSTHOG_PROJECT_API_KEY,
+    personalApiKey: process.env.POSTHOG_PERSONAL_API_KEY,
+    mcpUrl: process.env.POSTHOG_MCP_URL,
+    requestTimeoutMs: 1e4
+  });
+}
+async function runCapture(provider, allowWrites) {
+  if (!allowWrites) {
+    return {
+      skipped: true,
+      reason: "Set CONTRACTSPEC_POSTHOG_ALLOW_WRITES=true to enable capture."
+    };
+  }
+  const event = buildCaptureEvent();
+  if (provider.identify) {
+    await provider.identify({
+      distinctId: event.distinctId,
+      properties: { plan: "pro", source: "contractspec-example" }
+    });
+  }
+  await provider.capture(event);
+  return { captured: true, event };
+}
+async function runHogQLQuery(provider) {
+  if (!provider.queryHogQL) {
+    throw new Error("Analytics provider does not support HogQL queries.");
+  }
+  const query = buildHogQLQuery();
+  return provider.queryHogQL({ query });
+}
+async function runApiRequests(provider, allowWrites) {
+  const projectId = requireEnv("POSTHOG_PROJECT_ID");
+  const listRequest = {
+    method: "GET",
+    path: `/api/projects/${projectId}/feature_flags/`,
+    query: { limit: 5 }
+  };
+  const listResponse = await provider.request(listRequest);
+  const output = {
+    list: listResponse.data
+  };
+  if (!allowWrites) {
+    output.writeGuard = "Set CONTRACTSPEC_POSTHOG_ALLOW_WRITES=true to create/delete feature flags.";
+    return output;
+  }
+  const flagKey = `contractspec-example-${Date.now()}`;
+  const createResponse = await provider.request({
+    method: "POST",
+    path: `/api/projects/${projectId}/feature_flags/`,
+    body: {
+      name: "ContractSpec Example Flag",
+      key: flagKey,
+      active: true,
+      filters: {
+        groups: [
+          {
+            properties: [],
+            rollout_percentage: 100
+          }
+        ]
+      }
+    }
+  });
+  output.created = createResponse.data;
+  const createdId = extractId(createResponse);
+  if (createdId) {
+    const deleteResponse = await provider.request({
+      method: "DELETE",
+      path: `/api/projects/${projectId}/feature_flags/${createdId}`
+    });
+    output.deleted = deleteResponse.status;
+  } else {
+    output.deleted = "Skipped delete: response did not include an id.";
+  }
+  return output;
+}
+async function runReadOperations(provider) {
+  const now = new Date;
+  const from = new Date(now.getTime() - 24 * 60 * 60 * 1000);
+  const dateRange = { from, to: now };
+  const output = {
+    window: { from: from.toISOString(), to: now.toISOString() }
+  };
+  if (provider.getEvents) {
+    output.events = await provider.getEvents({ dateRange, limit: 5 });
+  } else {
+    output.events = "Provider does not support getEvents.";
+  }
+  if (provider.getPersons) {
+    output.persons = await provider.getPersons({ limit: 5 });
+  } else {
+    output.persons = "Provider does not support getPersons.";
+  }
+  if (provider.getInsights) {
+    output.insights = await provider.getInsights({ limit: 5 });
+  } else {
+    output.insights = "Provider does not support getInsights.";
+  }
+  if (provider.getFeatureFlags) {
+    output.featureFlags = await provider.getFeatureFlags({ limit: 5 });
+  } else {
+    output.featureFlags = "Provider does not support getFeatureFlags.";
+  }
+  return output;
+}
+async function runMcpToolCall(provider) {
+  if (!provider.callMcpTool) {
+    throw new Error("Analytics provider does not support MCP tool calls.");
+  }
+  const name = process.env.POSTHOG_MCP_TOOL_NAME ?? "posthog.query";
+  const argumentsValue = parseOptionalJsonEnv("POSTHOG_MCP_TOOL_ARGS", {
+    query: buildHogQLQuery()
+  });
+  return provider.callMcpTool({ name, arguments: argumentsValue });
+}
+function buildCaptureEvent() {
+  const distinctId = process.env.POSTHOG_DISTINCT_ID ?? "contractspec-demo";
+  const event = process.env.POSTHOG_EVENT_NAME ?? "contractspec.example.event";
+  return {
+    distinctId,
+    event,
+    properties: {
+      source: "contractspec-example",
+      environment: "development"
+    },
+    timestamp: new Date
+  };
+}
+function buildHogQLQuery() {
+  return "select event, count() as count " + "from events " + "where timestamp >= now() - interval 1 day " + "group by event " + "order by count desc " + "limit 5";
+}
+function buildCapturePreview() {
+  return {
+    event: buildCaptureEvent(),
+    hint: "Dry run enabled. Set CONTRACTSPEC_POSTHOG_DRY_RUN=false."
+  };
+}
+function buildRequestPreview() {
+  const projectId = process.env.POSTHOG_PROJECT_ID ?? "PROJECT_ID";
+  return {
+    listRequest: {
+      method: "GET",
+      path: `/api/projects/${projectId}/feature_flags/`,
+      query: { limit: 5 }
+    },
+    writeRequests: {
+      create: {
+        method: "POST",
+        path: `/api/projects/${projectId}/feature_flags/`
+      },
+      delete: {
+        method: "DELETE",
+        path: `/api/projects/${projectId}/feature_flags/{id}`
+      }
+    }
+  };
+}
+function buildReadPreview() {
+  return {
+    events: {
+      dateRange: "last_24_hours",
+      limit: 5
+    },
+    persons: {
+      limit: 5
+    },
+    insights: {
+      limit: 5
+    },
+    featureFlags: {
+      limit: 5
+    }
+  };
+}
+function buildMcpPreview() {
+  return {
+    url: process.env.POSTHOG_MCP_URL,
+    toolName: process.env.POSTHOG_MCP_TOOL_NAME ?? "posthog.query",
+    arguments: parseOptionalJsonEnv("POSTHOG_MCP_TOOL_ARGS", {
+      query: buildHogQLQuery()
+    })
+  };
+}
+function extractId(response) {
+  if (!response || typeof response !== "object")
+    return null;
+  const data = response.data;
+  if (data && (typeof data.id === "string" || typeof data.id === "number")) {
+    return data.id;
+  }
+  return null;
+}
+function resolveBooleanEnv(key, defaultValue) {
+  const value = process.env[key];
+  if (value === undefined)
+    return defaultValue;
+  return value.toLowerCase() === "true";
+}
+function requireEnv(key) {
+  const value = process.env[key];
+  if (!value) {
+    throw new Error(`Missing required env var: ${key}`);
+  }
+  return value;
+}
+function parseOptionalJsonEnv(key, fallback) {
+  const raw = process.env[key];
+  if (!raw)
+    return fallback;
+  try {
+    const parsed = JSON.parse(raw);
+    if (parsed && typeof parsed === "object")
+      return parsed;
+  } catch {
+    throw new Error(`Invalid JSON in ${key}`);
+  }
+  return fallback;
+}
+
+// src/run.ts
+runPosthogExampleFromEnv().then((result) => {
+  console.log(JSON.stringify(result, null, 2));
+}).catch((error) => {
+  console.error(error);
+  process.exitCode = 1;
+});

package/dist/posthog.d.ts

@@ -1,19 +1,15 @@
-import { AnalyticsQueryResult } from "@contractspec/integration.providers-impls/analytics";
-
-//#region src/posthog.d.ts
-type PosthogExampleMode = 'capture' | 'query' | 'request' | 'read' | 'all';
-interface PosthogExampleOutput {
-  mode: PosthogExampleMode;
-  dryRun: boolean;
-  allowWrites: boolean;
-  capture?: unknown;
-  query?: AnalyticsQueryResult | unknown;
-  request?: Record<string, unknown>;
-  read?: Record<string, unknown>;
-  mcp?: unknown;
+import type { AnalyticsQueryResult } from '@contractspec/integration.providers-impls/analytics';
+export type PosthogExampleMode = 'capture' | 'query' | 'request' | 'read' | 'all';
+export interface PosthogExampleOutput {
+    mode: PosthogExampleMode;
+    dryRun: boolean;
+    allowWrites: boolean;
+    capture?: unknown;
+    query?: AnalyticsQueryResult | unknown;
+    request?: Record<string, unknown>;
+    read?: Record<string, unknown>;
+    mcp?: unknown;
 }
-declare function runPosthogExampleFromEnv(): Promise<PosthogExampleOutput>;
-declare function resolvePosthogMode(): PosthogExampleMode;
-//#endregion
-export { PosthogExampleMode, PosthogExampleOutput, resolvePosthogMode, runPosthogExampleFromEnv };
+export declare function runPosthogExampleFromEnv(): Promise<PosthogExampleOutput>;
+export declare function resolvePosthogMode(): PosthogExampleMode;
 //# sourceMappingURL=posthog.d.ts.map

package/dist/posthog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"posthog.d.ts","names":[],"sources":["../src/posthog.ts"],"mappings":";;;KASY,kBAAA;AAAA,UAOK,oBAAA;EACf,IAAA,EAAM,kBAAA;EACN,MAAA;EACA,WAAA;EACA,OAAA;EACA,KAAA,GAAQ,oBAAA;EACR,OAAA,GAAU,MAAA;EACV,IAAA,GAAO,MAAA;EACP,GAAA;AAAA;AAAA,iBAGoB,wBAAA,CAAA,GAA4B,OAAA,CAAQ,oBAAA;AAAA,iBAqD1C,kBAAA,CAAA,GAAsB,kBAAA"}
+{"version":3,"file":"posthog.d.ts","sourceRoot":"","sources":["../src/posthog.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAGV,oBAAoB,EAGrB,MAAM,qDAAqD,CAAC;AAE7D,MAAM,MAAM,kBAAkB,GAC1B,SAAS,GACT,OAAO,GACP,SAAS,GACT,MAAM,GACN,KAAK,CAAC;AAEV,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,wBAAsB,wBAAwB,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAmD9E;AAED,wBAAgB,kBAAkB,IAAI,kBAAkB,CAcvD"}