@oxy-hq/sdk 2.12.0 → 2.13.0

package/dist/index.cjs

@@ -1,6 +1,6 @@
 // @oxy/sdk - TypeScript SDK for Oxy data platform
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_react = require('./react-DcT-mUPj.cjs');
+const require_react = require('./react-CkAQg9wB.cjs');
 let react = require("react");
 react = require_react.__toESM(react, 1);
 
@@ -1086,6 +1086,66 @@ var MetricTreeClient = class {
 	}
 };
 
+//#endregion
+//#region src/peerCohort.ts
+/**
+* Client for the `/semantic/cohort` endpoint. Surfaces airlayer's peer-cohort
+* benchmarking — comparing an entity's subjects against their declared peers
+* on a measure, with exclusions explained rather than silently dropped.
+*
+* Construction is internal to {@link OxyClient} — call `client.peerCohort`
+* to access an instance rather than building one yourself.
+*
+* @example
+* ```typescript
+* const client = await OxyClient.create({ projectId: "...", apiKey: "..." });
+* const result = await client.peerCohort.resolve({
+*   entity: "restaurant_id",
+*   measure: "orders.net_revenue",
+*   time_dimension: "orders.order_date",
+*   period: ["2025-09-01", "2025-09-30"],
+* });
+* for (const excluded of result.excluded) {
+*   console.warn(excluded.key, excluded.reason);
+* }
+* ```
+*/
+var PeerCohortClient = class {
+	constructor(config, request) {
+		this.config = config;
+		this.request = request;
+	}
+	path(suffix) {
+		return `/${this.config.projectId}${suffix}`;
+	}
+	buildQuery(extra = {}) {
+		const params = { ...extra };
+		if (this.config.branch) params.branch = this.config.branch;
+		const qs = new URLSearchParams(params).toString();
+		return qs ? `?${qs}` : "";
+	}
+	/**
+	* Resolve a subject's peer cohort and every peer's comparison against it.
+	*
+	* @example
+	* ```typescript
+	* const result = await client.peerCohort.resolve({
+	*   entity: "restaurant_id",
+	*   measure: "orders.net_revenue",
+	*   time_dimension: "orders.order_date",
+	*   period: ["2025-09-01", "2025-09-30"],
+	* });
+	* ```
+	*/
+	async resolve(request) {
+		const query = this.buildQuery();
+		return this.request(this.path(`/semantic/cohort${query}`), {
+			method: "POST",
+			body: JSON.stringify(request)
+		});
+	}
+};
+
 //#endregion
 exports.AnomaliesClient = AnomaliesClient;
 exports.MetricTreeClient = MetricTreeClient;
@@ -1093,6 +1153,7 @@ exports.OxyAnswer = require_react.OxyAnswer;
 exports.OxyApiError = require_react.OxyApiError;
 exports.OxyAppProvider = require_react.OxyAppProvider;
 exports.OxyChat = require_react.OxyChat;
+exports.PeerCohortClient = PeerCohortClient;
 exports.WorldModelScopeUnsupportedError = WorldModelScopeUnsupportedError;
 exports._resetCustomAppManifestCacheForTest = require_react._resetCustomAppManifestCacheForTest;
 exports.apiErrorFromResponse = require_react.apiErrorFromResponse;