@oxy-hq/sdk 2.12.0 → 2.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +62 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +163 -2
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +163 -2
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +62 -2
- package/dist/index.mjs.map +1 -1
- package/dist/{react-DcT-mUPj.cjs → react-CkAQg9wB.cjs} +65 -5
- package/dist/react-CkAQg9wB.cjs.map +1 -0
- package/dist/{react-BXGyzgz0.mjs → react-Cq3xULOr.mjs} +65 -5
- package/dist/react-Cq3xULOr.mjs.map +1 -0
- package/dist/{react-DW7Z96sD.d.mts → react-D-Sf973d.d.cts} +87 -2
- package/dist/react-D-Sf973d.d.cts.map +1 -0
- package/dist/{react-DW7Z96sD.d.cts → react-D-Sf973d.d.mts} +87 -2
- package/dist/react-D-Sf973d.d.mts.map +1 -0
- package/dist/shell.cjs +35 -1
- package/dist/shell.cjs.map +1 -1
- package/dist/shell.d.cts +25 -2
- package/dist/shell.d.cts.map +1 -1
- package/dist/shell.d.mts +25 -2
- package/dist/shell.d.mts.map +1 -1
- package/dist/shell.mjs +34 -2
- package/dist/shell.mjs.map +1 -1
- package/package.json +2 -2
- package/dist/react-BXGyzgz0.mjs.map +0 -1
- package/dist/react-DW7Z96sD.d.cts.map +0 -1
- package/dist/react-DW7Z96sD.d.mts.map +0 -1
- package/dist/react-DcT-mUPj.cjs.map +0 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
import { $ as loadCustomAppManifest, A as UseSemanticQueryOpts, B as FunctionError, C as UseProcedureRunInput, D as UseQueryOpts, E as UseQueryInput, F as useProcedureRun, G as apiErrorFromResponse, H as FunctionResult, I as useQuery, J as OxyAppFunctionManifest, K as interpretCustomAppError, L as useResolvedManifest, M as useAgentRun, N as useFunction, O as UseQueryResult, P as useOxyApp, Q as _resetCustomAppManifestCacheForTest, R as useSemanticQuery, S as UseFunctionResult, T as UseProcedureRunResult, U as CustomAppErrorReport, V as FunctionLog, W as OxyApiError, X as OxyAppPerformanceManifest, Y as OxyAppManifest, Z as ResolvedCustomAppManifest, _ as SemanticFilter, a as AppFetcher, b as UseAgentRunInput, c as OxyAppProvider, d as OxyChatProps, f as ProcedureProgress, g as SemanticDateRangeOp, h as SemanticArrayOp, i as AgentSqlArtifact, j as UseSemanticQueryResult, k as UseSemanticQueryInput, l as OxyAppProviderProps, m as ProcedureRunState, n as AgentRunEvent, o as OxyAnswer, p as ProcedureResult, q as LoadManifestOptions, r as AgentRunState, s as OxyAnswerProps, t as AgentArtifact, u as OxyChat, v as SemanticScalarOp, w as UseProcedureRunOpts, x as UseAgentRunResult, y as SemanticTimeDimension, z as useTrackEvent } from "./react-
|
|
2
|
+
import { $ as loadCustomAppManifest, A as UseSemanticQueryOpts, B as FunctionError, C as UseProcedureRunInput, D as UseQueryOpts, E as UseQueryInput, F as useProcedureRun, G as apiErrorFromResponse, H as FunctionResult, I as useQuery, J as OxyAppFunctionManifest, K as interpretCustomAppError, L as useResolvedManifest, M as useAgentRun, N as useFunction, O as UseQueryResult, P as useOxyApp, Q as _resetCustomAppManifestCacheForTest, R as useSemanticQuery, S as UseFunctionResult, T as UseProcedureRunResult, U as CustomAppErrorReport, V as FunctionLog, W as OxyApiError, X as OxyAppPerformanceManifest, Y as OxyAppManifest, Z as ResolvedCustomAppManifest, _ as SemanticFilter, a as AppFetcher, b as UseAgentRunInput, c as OxyAppProvider, d as OxyChatProps, f as ProcedureProgress, g as SemanticDateRangeOp, h as SemanticArrayOp, i as AgentSqlArtifact, j as UseSemanticQueryResult, k as UseSemanticQueryInput, l as OxyAppProviderProps, m as ProcedureRunState, n as AgentRunEvent, o as OxyAnswer, p as ProcedureResult, q as LoadManifestOptions, r as AgentRunState, s as OxyAnswerProps, t as AgentArtifact, u as OxyChat, v as SemanticScalarOp, w as UseProcedureRunOpts, x as UseAgentRunResult, y as SemanticTimeDimension, z as useTrackEvent } from "./react-D-Sf973d.cjs";
|
|
3
3
|
import { C as StorageDownloadUrl, D as StoragePutResult, E as StoragePutOptions, O as StorageUploadUrl, S as OxyWarehouseApi, T as StorageObject, _ as OxyReach, a as OxyEmailApi, b as OxyStorageApi, c as OxyFunctionHandler, d as OxyFunctionUser, f as OxyIdentityKind, g as OxyOrgTeam, h as OxyOrgPlace, i as OxyAirwayApi, k as StorageUploadUrlInput, l as OxyFunctionRequest, m as OxyOrgAssignment, n as EmailSendInput, o as OxyFetchResult, p as OxyOltpApi, r as EmailSendResult, s as OxyFunctionContext, t as EmailAttachment, u as OxyFunctionRow, v as OxySecretsApi, w as StorageListPage, x as OxyTransaction, y as OxySemanticApi } from "./function-context-D8eyZuw_.cjs";
|
|
4
4
|
//#region src/config.d.ts
|
|
5
5
|
/**
|
|
@@ -40,6 +40,156 @@ interface OxyConfig {
|
|
|
40
40
|
disableAutoAuth?: boolean;
|
|
41
41
|
}
|
|
42
42
|
//#endregion
|
|
43
|
+
//#region src/peerCohort.d.ts
|
|
44
|
+
/** How a subject's benchmark is computed from its peers. Serde snake_case:
|
|
45
|
+
* `"median"` | `"p75"` | `"best_peer"`. */
|
|
46
|
+
type BenchmarkStatistic = "median" | "p75" | "best_peer";
|
|
47
|
+
/**
|
|
48
|
+
* Why a subject was left out of the comparison entirely — distinct from
|
|
49
|
+
* `sufficient: false` on a {@link CohortSubject}, which still gets a computed
|
|
50
|
+
* comparison. This is the fix for a reference implementation where an excluded
|
|
51
|
+
* store "simply did not appear in the list and no screen said why": every
|
|
52
|
+
* exclusion here carries a reason, and a consumer MUST render these rather
|
|
53
|
+
* than silently drop them.
|
|
54
|
+
*/
|
|
55
|
+
interface ExcludedSubject {
|
|
56
|
+
/** For a NULL entity key, a synthesized stable id of the form
|
|
57
|
+
* `"(null) [<require values>]"` rather than an empty string. */
|
|
58
|
+
key: string;
|
|
59
|
+
/** Human-readable prose explaining the exclusion — NOT a coded enum, so
|
|
60
|
+
* render it verbatim rather than switching on it. */
|
|
61
|
+
reason: string;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* One subject's comparison against its peer cohort.
|
|
65
|
+
*
|
|
66
|
+
* `sufficient` reflects whether `peer_count` met the cohort's declared
|
|
67
|
+
* `min_peers`, but `min_peers` is a REPORTING predicate, never a filter: a
|
|
68
|
+
* subject below the threshold is still returned with `baseline` and `gap`
|
|
69
|
+
* computed from whatever peers it has. Never filter on `sufficient`
|
|
70
|
+
* client-side — surface it so the caller can decide whether to act on a
|
|
71
|
+
* comparison built from a thin peer set.
|
|
72
|
+
*/
|
|
73
|
+
interface CohortSubject {
|
|
74
|
+
key: string;
|
|
75
|
+
value: number;
|
|
76
|
+
/** The peer benchmark value. `0.0` when `peer_count === 0` — this is NOT a
|
|
77
|
+
* baseline of zero, there simply is none. Check `peer_count` before
|
|
78
|
+
* treating `baseline` as meaningful. */
|
|
79
|
+
baseline: number;
|
|
80
|
+
/** Oriented so a positive value always means opportunity, regardless of
|
|
81
|
+
* whether the underlying measure is "bigger is better" or the reverse.
|
|
82
|
+
* `0.0` when there are no peers to compare against. */
|
|
83
|
+
gap: number;
|
|
84
|
+
/** Non-reciprocal: appearing in another subject's `peers` does not imply
|
|
85
|
+
* this subject lists them back. */
|
|
86
|
+
peers: string[];
|
|
87
|
+
peer_count: number;
|
|
88
|
+
/** `peer_count >= cohort's min_peers`. A reporting flag, not a gate — see
|
|
89
|
+
* the type-level doc above. */
|
|
90
|
+
sufficient: boolean;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Result of resolving one subject's peer cohort and every peer's comparison
|
|
94
|
+
* against it.
|
|
95
|
+
*/
|
|
96
|
+
interface PeerCohortResult {
|
|
97
|
+
entity: string;
|
|
98
|
+
cohort: string;
|
|
99
|
+
measure: string;
|
|
100
|
+
statistic: BenchmarkStatistic;
|
|
101
|
+
/** `[start, end]` inclusive date strings for the measured period. */
|
|
102
|
+
period: [string, string];
|
|
103
|
+
/**
|
|
104
|
+
* The window peers were drawn from, when the cohort declares a peer band.
|
|
105
|
+
* `Some(period)` when the cohort declares a band with no explicit
|
|
106
|
+
* `window:` of its own; absent only when the cohort declares no band at
|
|
107
|
+
* all. Anchored at `period`'s START and extended backward, so it always
|
|
108
|
+
* CONTAINS `period` — never a disjoint comparison window.
|
|
109
|
+
*
|
|
110
|
+
* `| null` because this mirrors an `Option<(String, String)>` on a
|
|
111
|
+
* GIT-PINNED struct: `skip_serializing_if` is a serde attribute today, not
|
|
112
|
+
* a guarantee, so a reader must accept both encodings. Compare with
|
|
113
|
+
* `!= null`, never `!== undefined`.
|
|
114
|
+
*/
|
|
115
|
+
band_window?: [string, string] | null;
|
|
116
|
+
subjects: CohortSubject[];
|
|
117
|
+
excluded: ExcludedSubject[];
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Request to resolve a peer cohort. `cohort` and `band_window` are echoed
|
|
121
|
+
* back on {@link PeerCohortResult} specifically so a UI rendering them cannot
|
|
122
|
+
* drift from the query that produced them.
|
|
123
|
+
*/
|
|
124
|
+
interface CohortRequest {
|
|
125
|
+
/**
|
|
126
|
+
* The bare name of an `entities:` entry in the semantic model — e.g.
|
|
127
|
+
* `"restaurant_id"` — NOT a column name and NOT a qualified `view.entity`
|
|
128
|
+
* (`"stores.store"`). The server compares this verbatim against the
|
|
129
|
+
* entity half of a measure's `default_cohort: "entity.cohort_name"` and
|
|
130
|
+
* against `Entity::name` when locating the bound view; a qualified name
|
|
131
|
+
* fails both checks and a scoped caller gets `403 cohort_scope_unavailable`.
|
|
132
|
+
*/
|
|
133
|
+
entity: string;
|
|
134
|
+
measure: string;
|
|
135
|
+
time_dimension: string;
|
|
136
|
+
/** `[start, end]` inclusive date strings. */
|
|
137
|
+
period: [string, string];
|
|
138
|
+
/** Falls back to the measure's `default_cohort:` when omitted. */
|
|
139
|
+
cohort?: string;
|
|
140
|
+
/** Defaults to `"median"` server-side when omitted. */
|
|
141
|
+
statistic?: string;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* Shape of the inner request helper exposed by `OxyClient`. The peer-cohort
|
|
145
|
+
* client reuses it to inherit auth headers, timeout, baseUrl, and project
|
|
146
|
+
* scoping rather than reimplementing fetch end-to-end.
|
|
147
|
+
*/
|
|
148
|
+
type RequestFn$2 = <T>(endpoint: string, options?: RequestInit) => Promise<T>;
|
|
149
|
+
/**
|
|
150
|
+
* Client for the `/semantic/cohort` endpoint. Surfaces airlayer's peer-cohort
|
|
151
|
+
* benchmarking — comparing an entity's subjects against their declared peers
|
|
152
|
+
* on a measure, with exclusions explained rather than silently dropped.
|
|
153
|
+
*
|
|
154
|
+
* Construction is internal to {@link OxyClient} — call `client.peerCohort`
|
|
155
|
+
* to access an instance rather than building one yourself.
|
|
156
|
+
*
|
|
157
|
+
* @example
|
|
158
|
+
* ```typescript
|
|
159
|
+
* const client = await OxyClient.create({ projectId: "...", apiKey: "..." });
|
|
160
|
+
* const result = await client.peerCohort.resolve({
|
|
161
|
+
* entity: "restaurant_id",
|
|
162
|
+
* measure: "orders.net_revenue",
|
|
163
|
+
* time_dimension: "orders.order_date",
|
|
164
|
+
* period: ["2025-09-01", "2025-09-30"],
|
|
165
|
+
* });
|
|
166
|
+
* for (const excluded of result.excluded) {
|
|
167
|
+
* console.warn(excluded.key, excluded.reason);
|
|
168
|
+
* }
|
|
169
|
+
* ```
|
|
170
|
+
*/
|
|
171
|
+
declare class PeerCohortClient {
|
|
172
|
+
private readonly request;
|
|
173
|
+
private readonly config;
|
|
174
|
+
constructor(config: OxyConfig, request: RequestFn$2);
|
|
175
|
+
private path;
|
|
176
|
+
private buildQuery;
|
|
177
|
+
/**
|
|
178
|
+
* Resolve a subject's peer cohort and every peer's comparison against it.
|
|
179
|
+
*
|
|
180
|
+
* @example
|
|
181
|
+
* ```typescript
|
|
182
|
+
* const result = await client.peerCohort.resolve({
|
|
183
|
+
* entity: "restaurant_id",
|
|
184
|
+
* measure: "orders.net_revenue",
|
|
185
|
+
* time_dimension: "orders.order_date",
|
|
186
|
+
* period: ["2025-09-01", "2025-09-30"],
|
|
187
|
+
* });
|
|
188
|
+
* ```
|
|
189
|
+
*/
|
|
190
|
+
resolve(request: CohortRequest): Promise<PeerCohortResult>;
|
|
191
|
+
}
|
|
192
|
+
//#endregion
|
|
43
193
|
//#region src/metricTree.d.ts
|
|
44
194
|
type EdgeKind = "component" | "driver";
|
|
45
195
|
type DriverDirection = "positive" | "negative" | "unknown";
|
|
@@ -453,6 +603,17 @@ interface OpportunityRequest {
|
|
|
453
603
|
target: string;
|
|
454
604
|
time_dimension: string;
|
|
455
605
|
period: [string, string];
|
|
606
|
+
/**
|
|
607
|
+
* How a segment's benchmark is computed from its peers. Defaults to
|
|
608
|
+
* `"p75"` server-side when omitted.
|
|
609
|
+
*
|
|
610
|
+
* An airlayer upgrade deleted the engine's adaptive selection — best-peer
|
|
611
|
+
* for a dimension with too few segments for a percentile to mean anything,
|
|
612
|
+
* p75 once there were enough — in favor of an explicit required argument.
|
|
613
|
+
* No single fixed value reproduced the old behavior, so rather than
|
|
614
|
+
* freezing one server-side, the choice is now the caller's.
|
|
615
|
+
*/
|
|
616
|
+
statistic?: BenchmarkStatistic;
|
|
456
617
|
}
|
|
457
618
|
interface OpportunityResult {
|
|
458
619
|
target: string;
|
|
@@ -1432,5 +1593,5 @@ declare function createWorldModel(projectId: string | null, fetcher: AppFetcher)
|
|
|
1432
1593
|
*/
|
|
1433
1594
|
declare function useWorldModel(): WorldModelApi;
|
|
1434
1595
|
//#endregion
|
|
1435
|
-
export { type AdditivityClass, type AgentArtifact, type AgentRunEvent, type AgentRunState, type AgentSqlArtifact, AnomaliesClient, type Anomaly, type AnomalyFilter, type AnomalySeverity, type AnomalyStatus, type AppFetcher, type BaselineInstance, type BaselineRequest, type BaselineResponse, type BulkUpdateStatusResponse, type CustomAppDebugSnapshot, type CustomAppErrorReport, type DimensionOpportunity, type DistributionRequest, type DriverAttribution, type DriverConfidence, type DriverDirection, type DriverForm, type DriverStrength, type EdgeKind, type EmailAttachment, type EmailSendInput, type EmailSendResult, type ExpandedNode, type ExplainConfigOverride, type ExplainNode, type ExplainOptions, type ExplainOpts, type ExplainRequest, type ExplainResult, type ExplainSibling, type ExplainWarning, type FittedDriver, type ForecastPoint, type FunctionError, type FunctionLog, type FunctionResult, type HistoryPoint, type ListAnomaliesOptions, type ListAnomaliesResponse, type LoadManifestOptions, type MeasureProjection, type MeasureValues, type MetricEdge, type MetricHandle, type MetricNode, type MetricScope, type MetricTree, MetricTreeClient, type MetricTreeHookResult, type OpportunityRequest, type OpportunityResult, type OxyAirwayApi, OxyAnswer, type OxyAnswerProps, OxyApiError, type OxyAppFunctionManifest, type OxyAppLogLevel, type OxyAppLogger, type OxyAppManifest, type OxyAppPerformanceManifest, OxyAppProvider, type OxyAppProviderProps, OxyChat, type OxyChatProps, type OxyEmailApi, type OxyFetchResult, type OxyFunctionContext, type OxyFunctionHandler, type OxyFunctionRequest, type OxyFunctionRow, type OxyFunctionUser, type OxyIdentityKind, type OxyInjectedAppConfig, type OxyOltpApi, type OxyOrgAssignment, type OxyOrgPlace, type OxyOrgTeam, type OxyReach, type OxySecretsApi, type OxySemanticApi, type OxyStorageApi, type OxyTransaction, type OxyWarehouseApi, type PredictChange, type PredictImpact, type PredictOptions, type PredictResult, type ProcedureProgress, type ProcedureResult, type ProcedureRunState, type ProjectionGranularity, type ProjectionRequest, type ProjectionResponse, type ResolvedCustomAppManifest, type ScanFailure, type ScanOptions, type ScanResponse, type SegmentOpportunity, type SemanticArrayOp, type SemanticDateRangeOp, type SemanticFilter, type SemanticScalarOp, type SemanticTimeDimension, type SensitivityDriver, type SensitivityResult, type SizeOpts, type SkippedDimension, type SplitKind, type StorageDownloadUrl, type StorageListPage, type StorageObject, type StoragePutOptions, type StoragePutResult, type StorageUploadUrl, type StorageUploadUrlInput, type TimeDimensionsResponse, type UnvaluedNode, type UseAgentRunInput, type UseAgentRunResult, type UseFunctionResult, type UseMeasureBreakdownResult, type UseMetricTreeOpts, type UsePredictOpts, type UseProcedureRunInput, type UseProcedureRunOpts, type UseProcedureRunResult, type UseQueryInput, type UseQueryOpts, type UseQueryResult, type UseSemanticQueryInput, type UseSemanticQueryOpts, type UseSemanticQueryResult, type UseWorldModelGraphResult, type UseWorldModelInstancesOpts, type UseWorldModelInstancesResult, type WmBreakdownEdge, type WmBreakdownNode, type WmEntityCount, type WmFilterCountsResponse, type WmInstance, type WmInstancesResponse, type WmMeasureBreakdown, type WmMeasureBreakdownEvent, type WorldModel, type WorldModelApi, type WorldModelDimension, type WorldModelEdge, type WorldModelEntity, type WorldModelInducedMeasure, type WorldModelMeasure, WorldModelScopeUnsupportedError, _resetCustomAppManifestCacheForTest, apiErrorFromResponse, base64ToBytes, bytesToBase64, createWorldModel, getCustomAppDebug, getOxyAppLogger, interpretCustomAppError, loadCustomAppManifest, readInjectedAppConfig, readJsonSseStream, setOxyAppLogger, useAgentRun, useBaseline, useDistribution, useExplain, useFunction, useMeasureBreakdown, useMetricTree, useOpportunity, useOxyApp, usePredict, useProcedureRun, useProjection, useQuery, useResolvedManifest, useSemanticQuery, useSensitivity, useTimeDimensions, useTrackEvent, useWorldModel, useWorldModelGraph, useWorldModelInstances };
|
|
1596
|
+
export { type AdditivityClass, type AgentArtifact, type AgentRunEvent, type AgentRunState, type AgentSqlArtifact, AnomaliesClient, type Anomaly, type AnomalyFilter, type AnomalySeverity, type AnomalyStatus, type AppFetcher, type BaselineInstance, type BaselineRequest, type BaselineResponse, type BenchmarkStatistic, type BulkUpdateStatusResponse, type CohortRequest, type CohortSubject, type CustomAppDebugSnapshot, type CustomAppErrorReport, type DimensionOpportunity, type DistributionRequest, type DriverAttribution, type DriverConfidence, type DriverDirection, type DriverForm, type DriverStrength, type EdgeKind, type EmailAttachment, type EmailSendInput, type EmailSendResult, type ExcludedSubject, type ExpandedNode, type ExplainConfigOverride, type ExplainNode, type ExplainOptions, type ExplainOpts, type ExplainRequest, type ExplainResult, type ExplainSibling, type ExplainWarning, type FittedDriver, type ForecastPoint, type FunctionError, type FunctionLog, type FunctionResult, type HistoryPoint, type ListAnomaliesOptions, type ListAnomaliesResponse, type LoadManifestOptions, type MeasureProjection, type MeasureValues, type MetricEdge, type MetricHandle, type MetricNode, type MetricScope, type MetricTree, MetricTreeClient, type MetricTreeHookResult, type OpportunityRequest, type OpportunityResult, type OxyAirwayApi, OxyAnswer, type OxyAnswerProps, OxyApiError, type OxyAppFunctionManifest, type OxyAppLogLevel, type OxyAppLogger, type OxyAppManifest, type OxyAppPerformanceManifest, OxyAppProvider, type OxyAppProviderProps, OxyChat, type OxyChatProps, type OxyEmailApi, type OxyFetchResult, type OxyFunctionContext, type OxyFunctionHandler, type OxyFunctionRequest, type OxyFunctionRow, type OxyFunctionUser, type OxyIdentityKind, type OxyInjectedAppConfig, type OxyOltpApi, type OxyOrgAssignment, type OxyOrgPlace, type OxyOrgTeam, type OxyReach, type OxySecretsApi, type OxySemanticApi, type OxyStorageApi, type OxyTransaction, type OxyWarehouseApi, PeerCohortClient, type PeerCohortResult, type PredictChange, type PredictImpact, type PredictOptions, type PredictResult, type ProcedureProgress, type ProcedureResult, type ProcedureRunState, type ProjectionGranularity, type ProjectionRequest, type ProjectionResponse, type ResolvedCustomAppManifest, type ScanFailure, type ScanOptions, type ScanResponse, type SegmentOpportunity, type SemanticArrayOp, type SemanticDateRangeOp, type SemanticFilter, type SemanticScalarOp, type SemanticTimeDimension, type SensitivityDriver, type SensitivityResult, type SizeOpts, type SkippedDimension, type SplitKind, type StorageDownloadUrl, type StorageListPage, type StorageObject, type StoragePutOptions, type StoragePutResult, type StorageUploadUrl, type StorageUploadUrlInput, type TimeDimensionsResponse, type UnvaluedNode, type UseAgentRunInput, type UseAgentRunResult, type UseFunctionResult, type UseMeasureBreakdownResult, type UseMetricTreeOpts, type UsePredictOpts, type UseProcedureRunInput, type UseProcedureRunOpts, type UseProcedureRunResult, type UseQueryInput, type UseQueryOpts, type UseQueryResult, type UseSemanticQueryInput, type UseSemanticQueryOpts, type UseSemanticQueryResult, type UseWorldModelGraphResult, type UseWorldModelInstancesOpts, type UseWorldModelInstancesResult, type WmBreakdownEdge, type WmBreakdownNode, type WmEntityCount, type WmFilterCountsResponse, type WmInstance, type WmInstancesResponse, type WmMeasureBreakdown, type WmMeasureBreakdownEvent, type WorldModel, type WorldModelApi, type WorldModelDimension, type WorldModelEdge, type WorldModelEntity, type WorldModelInducedMeasure, type WorldModelMeasure, WorldModelScopeUnsupportedError, _resetCustomAppManifestCacheForTest, apiErrorFromResponse, base64ToBytes, bytesToBase64, createWorldModel, getCustomAppDebug, getOxyAppLogger, interpretCustomAppError, loadCustomAppManifest, readInjectedAppConfig, readJsonSseStream, setOxyAppLogger, useAgentRun, useBaseline, useDistribution, useExplain, useFunction, useMeasureBreakdown, useMetricTree, useOpportunity, useOxyApp, usePredict, useProcedureRun, useProjection, useQuery, useResolvedManifest, useSemanticQuery, useSensitivity, useTimeDimensions, useTrackEvent, useWorldModel, useWorldModelGraph, useWorldModelInstances };
|
|
1436
1597
|
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.cts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.cts","names":[],"sources":["../src/config.ts","../src/metricTree.ts","../src/anomalies.ts","../src/custom-app/base64.ts","../src/custom-app/debug.ts","../src/custom-app/inject.ts","../src/custom-app/logger.ts","../src/custom-app/metric-tree-hooks.tsx","../src/custom-app/sse.ts","../src/worldModel.ts","../src/custom-app/world-model-hooks.tsx","../src/custom-app/world-node.tsx"],"mappings":";;;;;;;UAGiB;;;;EAIf;;;;EAKA;;;;EAKA;;;;EAKA;;;;EAKA;;;;;;;EAQA;;;;;EAMA;;;;
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":[],"sources":["../src/config.ts","../src/peerCohort.ts","../src/metricTree.ts","../src/anomalies.ts","../src/custom-app/base64.ts","../src/custom-app/debug.ts","../src/custom-app/inject.ts","../src/custom-app/logger.ts","../src/custom-app/metric-tree-hooks.tsx","../src/custom-app/sse.ts","../src/worldModel.ts","../src/custom-app/world-model-hooks.tsx","../src/custom-app/world-node.tsx"],"mappings":";;;;;;;UAGiB;;;;EAIf;;;;EAKA;;;;EAKA;;;;EAKA;;;;EAKA;;;;;;;EAQA;;;;;EAMA;;;;;;KC/BU;;;;;;;;;UAUK;;;EAGf;;;EAGA;;;;;;;;;;;;UAae;EACf;EACA;;;;EAIA;;;;EAIA;;;EAGA;EACA;;;EAGA;;;;;;UAOe;EACf;EACA;EACA;EACA,WAAW;;EAEX;;;;;;;;;;;;;EAaA;EACA,UAAU;EACV,UAAU;;;;;;;UAQK;;;;;;;;;EASf;EACA;EACA;;EAEA;;EAEA;;EAEA;;;;;;;KAUU,eAAa,GAAG,kBAAkB,UAAU,gBAAgB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;cAwBnE;mBACM;mBACA;EAEjB,YAAY,QAAQ,WAAW,SAAS;UAKhC;UAIA;;;;;;;;;;;;;;EAoBF,QAAQ,SAAS,gBAAgB,QAAQ;;;;KCvKrC;KACA;KACA;KACA;;;;;;;;;KASA;UAWK;EACf;EACA;EACA;EACA;EACA;EACA;EACA;;;;;EAKA;EACA;;UAGe;EACf;EACA;EACA,MAAM;;EAEN;;;;;EAKA;EACA,WAAW;EACX,UAAU;EACV,YAAY;EACZ;EACA,MAAM;;EAEN;EACA;EACA;EACA;EACA;;UAGe;EACf,OAAO;EACP,OAAO;EACP;;;;EAIA;;UAKe;EACf;EACA;EACA;EACA;EACA,OAAO;EACP,WAAW;EACX,UAAU;EACV;EACA;;UAGe;EACf;EACA,SAAS;;UAKM;EACf;EACA;;UAGe;EACf;EACA;EACA;EACA;EACA,MAAM;EACN;;UAGe;EACf,QAAQ;EACR,SAAS;;;KAIC,gBAAgB;;;;;;;;UASX;EACf;EACA;EACA;;;;EAIA,OAAO;;;;;;;;;EASP;EACA;EACA;;;;EAIA;;;EAGA;EACA;;EAEA;;EAEA;;;;EAIA;;;;EAIA;IAAY;IAAY;IAAa;;;;EAGrC;;;;;EAKA;EACA;;;;EAIA;IAAe,MAAM;IAAY;IAAa;;EAC9C;;;UAIe;EACf;EACA;;;;UAKe;EACf;;EAEA;;UAGe;;;EAGf;EACA;;EAEA;EACA,WAAW;;UAGI;EACf,QAAQ;EACR,UAAU;EACV;;;EAGA;;;EAGA,SAAS;;UAGM;;;EAGf,SAAS;;EAET,eAAe;;KAKL;;;;;;;;;;;UAYK;;;EAGf;EACA;;EAEA;;;EAGA,WAAW;;EAEX,cAAc;;;;EAId;;;;;;;EAOA;;UAGe;;EAEf;EACA;;UAGe;EACf;EACA;;;;EAIA;EACA;;;;;;;;UASe;EACf;EACA,SAAS;EACT,UAAU;EACV;;;EAGA;;UAGe;EACf,aAAa;;EAEb;EACA;EACA,QAAQ;;;;EAIR;;KAKU;EACN;EAAmB;;EACnB;EAAmB;EAAmB;;EACtC;EAA6B;EAAmB;;EAChD;EAAuB;EAAmB;EAAe;;UAE9C;EACf,OAAO;EACP;EACA;EACA;;UAGe;EACf,OAAO;EACP;EACA;EACA;EACA;EACA;EACA,WAAW;EACX;EACA,WAAW;;;;;;;KAQD;;;;;UAMK;EACf;EACA;EACA;EACA;EACA;;UAGe;EACf;EACA;EACA;EACA;;;EAGA,YAAY;EACZ,eAAe;EACf;EACA,MAAM;;EAEN;EACA;EACA,cAAc;;KAGJ;EAEN;EACA;EACA;EACA;;EAGA;EACA;EACA;EACA;EACA;;EAGA;EACA;EACA;EACA;;UAGW;EACf;EACA;EACA;;UAGe;EACf;EACA;EACA;EACA;EACA,SAAS;;UAGM;EACf;EACA;EACA;EACA;EACA;EACA;EACA;EACA,OAAO;EACP;EACA,qBAAqB;EACrB;EACA,WAAW;;UAKI;EACf;EACA;EACA;EACA;EACA;;EAEA;;UAGe;EACf;EACA;;EAEA;EACA;EACA,UAAU;EACV;;UAGe;EACf;EACA;;UAGe;EACf;EACA;EACA;;;;;;;;;;;EAWA,YAAY;;UAGG;EACf;EACA;EACA;;;;;EAKA;EACA,YAAY;EACZ,oBAAoB;EACpB,YAAY;;;;;;;;UAWG;EACf;EACA;;EAEA;;UAKe;;EAEf,SAAS;;;;;;;KAUC,eAAa,GAAG,kBAAkB,UAAU,gBAAgB,QAAQ;;;;;;;;;;;;;;;;;cAkBnE;mBACM;mBACA;EAEjB,YAAY,QAAQ,WAAW,SAAS;UAKhC;UAIA;;;;;;;;;;;;;EAmBF,QAAQ,gBAAgB,QAAQ;;;;;;;;;;;;;;EAkBhC,eAAe,oBAAoB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkC3C,YAAY,SAAS,kBAAkB,QAAQ;;;;;;;;;;;;;;;;;;;EA0B/C,QAAQ,SAAS,iBAAiB,UAAS,iBAAsB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4CzE,cAAc,SAAS,oBAAoB,QAAQ;;;;;;;;;;;;;;;EAsBnD,QAAQ,SAAS,iBAAiB,QAAQ;;;;;;;;;;;;;;;;;EAwB1C,kBAAkB,SAAS,qBAAqB,QAAQ;;;;KCntBpD;KACA;;UAGK;;EAEf;;EAEA;;;;;;;UAQe;EACf;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA,UAAU;EACV,QAAQ;EACR;;;;;EAKA;;;;;;;EAOA,SAAS;;;;;;;;EAQT;;EAEA,gBAAgB;EAChB;EACA;EACA;;UAGe;EACf,SAAS;;;;;;EAMT;;;;;;;;;;EAUA;;;;;EAKA;;UAGe;EACf,WAAW;;;;;;;;;;;;;;;;;;;;EAoBX;;;;;;;;;;;;EAYA;EACA;;;;;;EAMA;;;;;;;;;;;;;;EAcA;;UAGe;;;EAGf;;;;;;;;;;EAUA;;UAGe;;EAEf;;;UAIe;EACf;EACA;EACA;EACA;;EAEA;;EAEA,SAAS;EACT;;UAGe;EACf;EACA;EACA;;;;;;;EAOA;;;;;EAKA,UAAU;;UAGK;;EAEf;;KAKU,aAAa,GAAG,kBAAkB,UAAU,gBAAgB,QAAQ;;;;;;;;;;;;;;cAsBnE;mBACM;mBACA;EAEjB,YAAY,QAAQ,WAAW,SAAS;UAKhC;UAIA;;;;;;;;;;;;;;;EAqBF,KAAK,UAAS,uBAA4B,QAAQ;;;;;;;;;;;;;;;;;;;;;;EAqClD,KAAK,UAAS,cAAmB,QAAQ;;;;EAWzC,aAAa,mBAAmB,QAAQ,gBAAgB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0ChE,iBACJ;IAAU;IAAgB;IAAqB,eAAe;KAC9D,QAAQ,gBACP,QAAQ;;;;;;;;;;EA6BL,QAAQ,mBAAmB,UAAS,iBAAsB,QAAQ;;;;;;;;;;;;;;;;;;;;iBChV1D,cAAc,OAAO,aAAa,cAAc;;;;;;;;iBA8BhD,cAAc,iBAAiB;;;;;;UC9D9B;EACf;EACA;EACA;IACE;IACA;IACA;IACA;IACA;IACA;IACA;;EAEF;EACA;;EAEA,UAAU;EACV;EACA,UAAU;IAAQ;IAAc;;;;;;;;;iBASZ,kBACpB,UAAU,4BACT,QAAQ;;;;;;;;UCnCM;EACf;EACA;EACA;EACA;EACA;EACA;;EAEA;;QAGM;YACI;IACR,cAAc;;;;;;;;;iBAUF,yBAAyB;;;KCpB7B;UAEK;EACf,IAAI,OAAO,gBAAgB,aAAa,MAAM;;;iBAMhC,gBAAgB,QAAQ;;iBAKxB,mBAAmB;;;;UCSlB,qBAAqB;EACpC,MAAM;EACN;EACA,OAAO;;EAEP;;UAGQ;;EAER;;UA+De,0BAA0B;;EAEzC;;;;;;;iBAQc,cAAc,OAAM,oBAAyB,qBAAqB;;;;;iBAsBlE,eACd,0BACA,OAAM,eACL,qBAAqB;UAmBP,uBAAuB,cAAc;;;;;;;;;;;;;iBActC,WACd,SAAS,wBACT,OAAM,iBACL,qBAAqB;;;;;;;;;;;;;;iBA0CR,YACd,SAAS,wBACT,OAAM,eACL,qBAAqB;;;;;;;;;;;;;;iBAiCR,cACd,SAAS,0BACT,OAAM,eACL,qBAAqB;;;;;;;iBA0BR,WACd,SAAS,uBACT,OAAM,eACL,qBAAqB;;;;;;iBAyBR,gBACd,SAAS,4BACT,OAAM,eACL,qBAAqB;;;;;;;iBA0BR,eACd,SAAS,2BACT,OAAM,eACL,qBAAqB;;;;;;iBAyBR,kBACd,OAAM,eACL,qBAAqB;;;;;;;;iBCzWF,kBAAkB,GACtC,MAAM,UACN,UAAU,OAAO,aAChB;;;;KCNS;UAEK;EACf;EACA;EACA,YAAY;EACZ;EACA;EACA;;EAEA;;;UAIe,iCAAiC;;EAEhD;;EAEA;;UAGe;EACf;EACA;EACA;EACA;;UAGe;EACf;EACA;EACA;EACA;EACA;EACA,YAAY;EACZ,cAAc;EACd,kBAAkB;EAClB;;;UAIe;EACf;EACA;EACA;;UAGe;EACf,UAAU;EACV,OAAO;;UAKQ;EACf;EACA;;;;;EAKA;IAAa;IAAY;IAAc;IAAsB;;;UAG9C;EACf;EACA;EACA,OAAO;;UAKQ;EACf;EACA;;EAEA;;EAEA;;UAGe;EACf,QAAQ,eAAe;;UAKR;;EAEf;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;EAEA;EACA;;UAGe;EACf;EACA;EACA;EACA;;;;KAKU;EAEN;EACA;EACA,OAAO,KAAK;EACZ,OAAO;;EAEP;EAAe;EAAiB;EAAsB;;EACtD;;;;UAIW;EACf;EACA,OAAO;EACP,OAAO;;;;UC9GQ;EACf,MAAM;EACN;EACA,OAAO;EACP;;;;;;;;;;;;iBAac,mBAAmB;EAAQ;IAA2B;UA6CrD;;EAEf;;EAEA;EACA;;;;;;;;EAQA;;UAGe;EACf,MAAM;EACN;EACA,OAAO;EACP;;;;;;;iBAQc,uBACd,yBACA,OAAM,6BACL;UAwDc;;EAEf,WAAW;EACX;EACA;EACA,OAAO;;;;;;;;iBAmCO,oBACd,yBACA,yBACA,yBACC;;;;KClLS,cAAc,SAAS;;;KAIvB,cAAc,KAAK;;;KAInB,WAAW,KAAK;;;UAIX;;EAEf,MAAM;;EAEN,MAAM;;EAEN,QAAQ;;;;;;;UAQO;;WAEN;;WAEA,OAAO;;EAEhB,KAAK,SAAS,cAAc,QAAQ;;EAEpC,OAAO,SAAS,cAAc,QAAQ;;EAEtC,QAAQ,SAAS,cAAc,QAAQ;;EAEvC,QAAQ,MAAM,aAAa,SAAS,cAAc,QAAQ;;EAE1D,KAAK,MAAM,UAAU,SAAS,cAAc,QAAQ;;EAEpD,MAAM,OAAO,yBAAyB;;;;;;;UAQvB;;WAEN;;EAET,KAAK,eAAe,SAAS,cAAc,QAAQ;;EAEnD,OAAO,aAAa;;;;;;;;cAST,wCAAwC;WAC1C;WACA,OAAO;EAChB,YAAY,cAAc,OAAO;;;;;;;iBAkBnB,iBAAiB,0BAA0B,SAAS,aAAa;;;;;;;;;;;;;;;;;;;;;;iBAqGjE,iBAAiB"}
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
import { $ as loadCustomAppManifest, A as UseSemanticQueryOpts, B as FunctionError, C as UseProcedureRunInput, D as UseQueryOpts, E as UseQueryInput, F as useProcedureRun, G as apiErrorFromResponse, H as FunctionResult, I as useQuery, J as OxyAppFunctionManifest, K as interpretCustomAppError, L as useResolvedManifest, M as useAgentRun, N as useFunction, O as UseQueryResult, P as useOxyApp, Q as _resetCustomAppManifestCacheForTest, R as useSemanticQuery, S as UseFunctionResult, T as UseProcedureRunResult, U as CustomAppErrorReport, V as FunctionLog, W as OxyApiError, X as OxyAppPerformanceManifest, Y as OxyAppManifest, Z as ResolvedCustomAppManifest, _ as SemanticFilter, a as AppFetcher, b as UseAgentRunInput, c as OxyAppProvider, d as OxyChatProps, f as ProcedureProgress, g as SemanticDateRangeOp, h as SemanticArrayOp, i as AgentSqlArtifact, j as UseSemanticQueryResult, k as UseSemanticQueryInput, l as OxyAppProviderProps, m as ProcedureRunState, n as AgentRunEvent, o as OxyAnswer, p as ProcedureResult, q as LoadManifestOptions, r as AgentRunState, s as OxyAnswerProps, t as AgentArtifact, u as OxyChat, v as SemanticScalarOp, w as UseProcedureRunOpts, x as UseAgentRunResult, y as SemanticTimeDimension, z as useTrackEvent } from "./react-
|
|
2
|
+
import { $ as loadCustomAppManifest, A as UseSemanticQueryOpts, B as FunctionError, C as UseProcedureRunInput, D as UseQueryOpts, E as UseQueryInput, F as useProcedureRun, G as apiErrorFromResponse, H as FunctionResult, I as useQuery, J as OxyAppFunctionManifest, K as interpretCustomAppError, L as useResolvedManifest, M as useAgentRun, N as useFunction, O as UseQueryResult, P as useOxyApp, Q as _resetCustomAppManifestCacheForTest, R as useSemanticQuery, S as UseFunctionResult, T as UseProcedureRunResult, U as CustomAppErrorReport, V as FunctionLog, W as OxyApiError, X as OxyAppPerformanceManifest, Y as OxyAppManifest, Z as ResolvedCustomAppManifest, _ as SemanticFilter, a as AppFetcher, b as UseAgentRunInput, c as OxyAppProvider, d as OxyChatProps, f as ProcedureProgress, g as SemanticDateRangeOp, h as SemanticArrayOp, i as AgentSqlArtifact, j as UseSemanticQueryResult, k as UseSemanticQueryInput, l as OxyAppProviderProps, m as ProcedureRunState, n as AgentRunEvent, o as OxyAnswer, p as ProcedureResult, q as LoadManifestOptions, r as AgentRunState, s as OxyAnswerProps, t as AgentArtifact, u as OxyChat, v as SemanticScalarOp, w as UseProcedureRunOpts, x as UseAgentRunResult, y as SemanticTimeDimension, z as useTrackEvent } from "./react-D-Sf973d.mjs";
|
|
3
3
|
import { C as StorageDownloadUrl, D as StoragePutResult, E as StoragePutOptions, O as StorageUploadUrl, S as OxyWarehouseApi, T as StorageObject, _ as OxyReach, a as OxyEmailApi, b as OxyStorageApi, c as OxyFunctionHandler, d as OxyFunctionUser, f as OxyIdentityKind, g as OxyOrgTeam, h as OxyOrgPlace, i as OxyAirwayApi, k as StorageUploadUrlInput, l as OxyFunctionRequest, m as OxyOrgAssignment, n as EmailSendInput, o as OxyFetchResult, p as OxyOltpApi, r as EmailSendResult, s as OxyFunctionContext, t as EmailAttachment, u as OxyFunctionRow, v as OxySecretsApi, w as StorageListPage, x as OxyTransaction, y as OxySemanticApi } from "./function-context-D8eyZuw_.mjs";
|
|
4
4
|
//#region src/config.d.ts
|
|
5
5
|
/**
|
|
@@ -40,6 +40,156 @@ interface OxyConfig {
|
|
|
40
40
|
disableAutoAuth?: boolean;
|
|
41
41
|
}
|
|
42
42
|
//#endregion
|
|
43
|
+
//#region src/peerCohort.d.ts
|
|
44
|
+
/** How a subject's benchmark is computed from its peers. Serde snake_case:
|
|
45
|
+
* `"median"` | `"p75"` | `"best_peer"`. */
|
|
46
|
+
type BenchmarkStatistic = "median" | "p75" | "best_peer";
|
|
47
|
+
/**
|
|
48
|
+
* Why a subject was left out of the comparison entirely — distinct from
|
|
49
|
+
* `sufficient: false` on a {@link CohortSubject}, which still gets a computed
|
|
50
|
+
* comparison. This is the fix for a reference implementation where an excluded
|
|
51
|
+
* store "simply did not appear in the list and no screen said why": every
|
|
52
|
+
* exclusion here carries a reason, and a consumer MUST render these rather
|
|
53
|
+
* than silently drop them.
|
|
54
|
+
*/
|
|
55
|
+
interface ExcludedSubject {
|
|
56
|
+
/** For a NULL entity key, a synthesized stable id of the form
|
|
57
|
+
* `"(null) [<require values>]"` rather than an empty string. */
|
|
58
|
+
key: string;
|
|
59
|
+
/** Human-readable prose explaining the exclusion — NOT a coded enum, so
|
|
60
|
+
* render it verbatim rather than switching on it. */
|
|
61
|
+
reason: string;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* One subject's comparison against its peer cohort.
|
|
65
|
+
*
|
|
66
|
+
* `sufficient` reflects whether `peer_count` met the cohort's declared
|
|
67
|
+
* `min_peers`, but `min_peers` is a REPORTING predicate, never a filter: a
|
|
68
|
+
* subject below the threshold is still returned with `baseline` and `gap`
|
|
69
|
+
* computed from whatever peers it has. Never filter on `sufficient`
|
|
70
|
+
* client-side — surface it so the caller can decide whether to act on a
|
|
71
|
+
* comparison built from a thin peer set.
|
|
72
|
+
*/
|
|
73
|
+
interface CohortSubject {
|
|
74
|
+
key: string;
|
|
75
|
+
value: number;
|
|
76
|
+
/** The peer benchmark value. `0.0` when `peer_count === 0` — this is NOT a
|
|
77
|
+
* baseline of zero, there simply is none. Check `peer_count` before
|
|
78
|
+
* treating `baseline` as meaningful. */
|
|
79
|
+
baseline: number;
|
|
80
|
+
/** Oriented so a positive value always means opportunity, regardless of
|
|
81
|
+
* whether the underlying measure is "bigger is better" or the reverse.
|
|
82
|
+
* `0.0` when there are no peers to compare against. */
|
|
83
|
+
gap: number;
|
|
84
|
+
/** Non-reciprocal: appearing in another subject's `peers` does not imply
|
|
85
|
+
* this subject lists them back. */
|
|
86
|
+
peers: string[];
|
|
87
|
+
peer_count: number;
|
|
88
|
+
/** `peer_count >= cohort's min_peers`. A reporting flag, not a gate — see
|
|
89
|
+
* the type-level doc above. */
|
|
90
|
+
sufficient: boolean;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Result of resolving one subject's peer cohort and every peer's comparison
|
|
94
|
+
* against it.
|
|
95
|
+
*/
|
|
96
|
+
interface PeerCohortResult {
|
|
97
|
+
entity: string;
|
|
98
|
+
cohort: string;
|
|
99
|
+
measure: string;
|
|
100
|
+
statistic: BenchmarkStatistic;
|
|
101
|
+
/** `[start, end]` inclusive date strings for the measured period. */
|
|
102
|
+
period: [string, string];
|
|
103
|
+
/**
|
|
104
|
+
* The window peers were drawn from, when the cohort declares a peer band.
|
|
105
|
+
* `Some(period)` when the cohort declares a band with no explicit
|
|
106
|
+
* `window:` of its own; absent only when the cohort declares no band at
|
|
107
|
+
* all. Anchored at `period`'s START and extended backward, so it always
|
|
108
|
+
* CONTAINS `period` — never a disjoint comparison window.
|
|
109
|
+
*
|
|
110
|
+
* `| null` because this mirrors an `Option<(String, String)>` on a
|
|
111
|
+
* GIT-PINNED struct: `skip_serializing_if` is a serde attribute today, not
|
|
112
|
+
* a guarantee, so a reader must accept both encodings. Compare with
|
|
113
|
+
* `!= null`, never `!== undefined`.
|
|
114
|
+
*/
|
|
115
|
+
band_window?: [string, string] | null;
|
|
116
|
+
subjects: CohortSubject[];
|
|
117
|
+
excluded: ExcludedSubject[];
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Request to resolve a peer cohort. `cohort` and `band_window` are echoed
|
|
121
|
+
* back on {@link PeerCohortResult} specifically so a UI rendering them cannot
|
|
122
|
+
* drift from the query that produced them.
|
|
123
|
+
*/
|
|
124
|
+
interface CohortRequest {
|
|
125
|
+
/**
|
|
126
|
+
* The bare name of an `entities:` entry in the semantic model — e.g.
|
|
127
|
+
* `"restaurant_id"` — NOT a column name and NOT a qualified `view.entity`
|
|
128
|
+
* (`"stores.store"`). The server compares this verbatim against the
|
|
129
|
+
* entity half of a measure's `default_cohort: "entity.cohort_name"` and
|
|
130
|
+
* against `Entity::name` when locating the bound view; a qualified name
|
|
131
|
+
* fails both checks and a scoped caller gets `403 cohort_scope_unavailable`.
|
|
132
|
+
*/
|
|
133
|
+
entity: string;
|
|
134
|
+
measure: string;
|
|
135
|
+
time_dimension: string;
|
|
136
|
+
/** `[start, end]` inclusive date strings. */
|
|
137
|
+
period: [string, string];
|
|
138
|
+
/** Falls back to the measure's `default_cohort:` when omitted. */
|
|
139
|
+
cohort?: string;
|
|
140
|
+
/** Defaults to `"median"` server-side when omitted. */
|
|
141
|
+
statistic?: string;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* Shape of the inner request helper exposed by `OxyClient`. The peer-cohort
|
|
145
|
+
* client reuses it to inherit auth headers, timeout, baseUrl, and project
|
|
146
|
+
* scoping rather than reimplementing fetch end-to-end.
|
|
147
|
+
*/
|
|
148
|
+
type RequestFn$2 = <T>(endpoint: string, options?: RequestInit) => Promise<T>;
|
|
149
|
+
/**
|
|
150
|
+
* Client for the `/semantic/cohort` endpoint. Surfaces airlayer's peer-cohort
|
|
151
|
+
* benchmarking — comparing an entity's subjects against their declared peers
|
|
152
|
+
* on a measure, with exclusions explained rather than silently dropped.
|
|
153
|
+
*
|
|
154
|
+
* Construction is internal to {@link OxyClient} — call `client.peerCohort`
|
|
155
|
+
* to access an instance rather than building one yourself.
|
|
156
|
+
*
|
|
157
|
+
* @example
|
|
158
|
+
* ```typescript
|
|
159
|
+
* const client = await OxyClient.create({ projectId: "...", apiKey: "..." });
|
|
160
|
+
* const result = await client.peerCohort.resolve({
|
|
161
|
+
* entity: "restaurant_id",
|
|
162
|
+
* measure: "orders.net_revenue",
|
|
163
|
+
* time_dimension: "orders.order_date",
|
|
164
|
+
* period: ["2025-09-01", "2025-09-30"],
|
|
165
|
+
* });
|
|
166
|
+
* for (const excluded of result.excluded) {
|
|
167
|
+
* console.warn(excluded.key, excluded.reason);
|
|
168
|
+
* }
|
|
169
|
+
* ```
|
|
170
|
+
*/
|
|
171
|
+
declare class PeerCohortClient {
|
|
172
|
+
private readonly request;
|
|
173
|
+
private readonly config;
|
|
174
|
+
constructor(config: OxyConfig, request: RequestFn$2);
|
|
175
|
+
private path;
|
|
176
|
+
private buildQuery;
|
|
177
|
+
/**
|
|
178
|
+
* Resolve a subject's peer cohort and every peer's comparison against it.
|
|
179
|
+
*
|
|
180
|
+
* @example
|
|
181
|
+
* ```typescript
|
|
182
|
+
* const result = await client.peerCohort.resolve({
|
|
183
|
+
* entity: "restaurant_id",
|
|
184
|
+
* measure: "orders.net_revenue",
|
|
185
|
+
* time_dimension: "orders.order_date",
|
|
186
|
+
* period: ["2025-09-01", "2025-09-30"],
|
|
187
|
+
* });
|
|
188
|
+
* ```
|
|
189
|
+
*/
|
|
190
|
+
resolve(request: CohortRequest): Promise<PeerCohortResult>;
|
|
191
|
+
}
|
|
192
|
+
//#endregion
|
|
43
193
|
//#region src/metricTree.d.ts
|
|
44
194
|
type EdgeKind = "component" | "driver";
|
|
45
195
|
type DriverDirection = "positive" | "negative" | "unknown";
|
|
@@ -453,6 +603,17 @@ interface OpportunityRequest {
|
|
|
453
603
|
target: string;
|
|
454
604
|
time_dimension: string;
|
|
455
605
|
period: [string, string];
|
|
606
|
+
/**
|
|
607
|
+
* How a segment's benchmark is computed from its peers. Defaults to
|
|
608
|
+
* `"p75"` server-side when omitted.
|
|
609
|
+
*
|
|
610
|
+
* An airlayer upgrade deleted the engine's adaptive selection — best-peer
|
|
611
|
+
* for a dimension with too few segments for a percentile to mean anything,
|
|
612
|
+
* p75 once there were enough — in favor of an explicit required argument.
|
|
613
|
+
* No single fixed value reproduced the old behavior, so rather than
|
|
614
|
+
* freezing one server-side, the choice is now the caller's.
|
|
615
|
+
*/
|
|
616
|
+
statistic?: BenchmarkStatistic;
|
|
456
617
|
}
|
|
457
618
|
interface OpportunityResult {
|
|
458
619
|
target: string;
|
|
@@ -1432,5 +1593,5 @@ declare function createWorldModel(projectId: string | null, fetcher: AppFetcher)
|
|
|
1432
1593
|
*/
|
|
1433
1594
|
declare function useWorldModel(): WorldModelApi;
|
|
1434
1595
|
//#endregion
|
|
1435
|
-
export { type AdditivityClass, type AgentArtifact, type AgentRunEvent, type AgentRunState, type AgentSqlArtifact, AnomaliesClient, type Anomaly, type AnomalyFilter, type AnomalySeverity, type AnomalyStatus, type AppFetcher, type BaselineInstance, type BaselineRequest, type BaselineResponse, type BulkUpdateStatusResponse, type CustomAppDebugSnapshot, type CustomAppErrorReport, type DimensionOpportunity, type DistributionRequest, type DriverAttribution, type DriverConfidence, type DriverDirection, type DriverForm, type DriverStrength, type EdgeKind, type EmailAttachment, type EmailSendInput, type EmailSendResult, type ExpandedNode, type ExplainConfigOverride, type ExplainNode, type ExplainOptions, type ExplainOpts, type ExplainRequest, type ExplainResult, type ExplainSibling, type ExplainWarning, type FittedDriver, type ForecastPoint, type FunctionError, type FunctionLog, type FunctionResult, type HistoryPoint, type ListAnomaliesOptions, type ListAnomaliesResponse, type LoadManifestOptions, type MeasureProjection, type MeasureValues, type MetricEdge, type MetricHandle, type MetricNode, type MetricScope, type MetricTree, MetricTreeClient, type MetricTreeHookResult, type OpportunityRequest, type OpportunityResult, type OxyAirwayApi, OxyAnswer, type OxyAnswerProps, OxyApiError, type OxyAppFunctionManifest, type OxyAppLogLevel, type OxyAppLogger, type OxyAppManifest, type OxyAppPerformanceManifest, OxyAppProvider, type OxyAppProviderProps, OxyChat, type OxyChatProps, type OxyEmailApi, type OxyFetchResult, type OxyFunctionContext, type OxyFunctionHandler, type OxyFunctionRequest, type OxyFunctionRow, type OxyFunctionUser, type OxyIdentityKind, type OxyInjectedAppConfig, type OxyOltpApi, type OxyOrgAssignment, type OxyOrgPlace, type OxyOrgTeam, type OxyReach, type OxySecretsApi, type OxySemanticApi, type OxyStorageApi, type OxyTransaction, type OxyWarehouseApi, type PredictChange, type PredictImpact, type PredictOptions, type PredictResult, type ProcedureProgress, type ProcedureResult, type ProcedureRunState, type ProjectionGranularity, type ProjectionRequest, type ProjectionResponse, type ResolvedCustomAppManifest, type ScanFailure, type ScanOptions, type ScanResponse, type SegmentOpportunity, type SemanticArrayOp, type SemanticDateRangeOp, type SemanticFilter, type SemanticScalarOp, type SemanticTimeDimension, type SensitivityDriver, type SensitivityResult, type SizeOpts, type SkippedDimension, type SplitKind, type StorageDownloadUrl, type StorageListPage, type StorageObject, type StoragePutOptions, type StoragePutResult, type StorageUploadUrl, type StorageUploadUrlInput, type TimeDimensionsResponse, type UnvaluedNode, type UseAgentRunInput, type UseAgentRunResult, type UseFunctionResult, type UseMeasureBreakdownResult, type UseMetricTreeOpts, type UsePredictOpts, type UseProcedureRunInput, type UseProcedureRunOpts, type UseProcedureRunResult, type UseQueryInput, type UseQueryOpts, type UseQueryResult, type UseSemanticQueryInput, type UseSemanticQueryOpts, type UseSemanticQueryResult, type UseWorldModelGraphResult, type UseWorldModelInstancesOpts, type UseWorldModelInstancesResult, type WmBreakdownEdge, type WmBreakdownNode, type WmEntityCount, type WmFilterCountsResponse, type WmInstance, type WmInstancesResponse, type WmMeasureBreakdown, type WmMeasureBreakdownEvent, type WorldModel, type WorldModelApi, type WorldModelDimension, type WorldModelEdge, type WorldModelEntity, type WorldModelInducedMeasure, type WorldModelMeasure, WorldModelScopeUnsupportedError, _resetCustomAppManifestCacheForTest, apiErrorFromResponse, base64ToBytes, bytesToBase64, createWorldModel, getCustomAppDebug, getOxyAppLogger, interpretCustomAppError, loadCustomAppManifest, readInjectedAppConfig, readJsonSseStream, setOxyAppLogger, useAgentRun, useBaseline, useDistribution, useExplain, useFunction, useMeasureBreakdown, useMetricTree, useOpportunity, useOxyApp, usePredict, useProcedureRun, useProjection, useQuery, useResolvedManifest, useSemanticQuery, useSensitivity, useTimeDimensions, useTrackEvent, useWorldModel, useWorldModelGraph, useWorldModelInstances };
|
|
1596
|
+
export { type AdditivityClass, type AgentArtifact, type AgentRunEvent, type AgentRunState, type AgentSqlArtifact, AnomaliesClient, type Anomaly, type AnomalyFilter, type AnomalySeverity, type AnomalyStatus, type AppFetcher, type BaselineInstance, type BaselineRequest, type BaselineResponse, type BenchmarkStatistic, type BulkUpdateStatusResponse, type CohortRequest, type CohortSubject, type CustomAppDebugSnapshot, type CustomAppErrorReport, type DimensionOpportunity, type DistributionRequest, type DriverAttribution, type DriverConfidence, type DriverDirection, type DriverForm, type DriverStrength, type EdgeKind, type EmailAttachment, type EmailSendInput, type EmailSendResult, type ExcludedSubject, type ExpandedNode, type ExplainConfigOverride, type ExplainNode, type ExplainOptions, type ExplainOpts, type ExplainRequest, type ExplainResult, type ExplainSibling, type ExplainWarning, type FittedDriver, type ForecastPoint, type FunctionError, type FunctionLog, type FunctionResult, type HistoryPoint, type ListAnomaliesOptions, type ListAnomaliesResponse, type LoadManifestOptions, type MeasureProjection, type MeasureValues, type MetricEdge, type MetricHandle, type MetricNode, type MetricScope, type MetricTree, MetricTreeClient, type MetricTreeHookResult, type OpportunityRequest, type OpportunityResult, type OxyAirwayApi, OxyAnswer, type OxyAnswerProps, OxyApiError, type OxyAppFunctionManifest, type OxyAppLogLevel, type OxyAppLogger, type OxyAppManifest, type OxyAppPerformanceManifest, OxyAppProvider, type OxyAppProviderProps, OxyChat, type OxyChatProps, type OxyEmailApi, type OxyFetchResult, type OxyFunctionContext, type OxyFunctionHandler, type OxyFunctionRequest, type OxyFunctionRow, type OxyFunctionUser, type OxyIdentityKind, type OxyInjectedAppConfig, type OxyOltpApi, type OxyOrgAssignment, type OxyOrgPlace, type OxyOrgTeam, type OxyReach, type OxySecretsApi, type OxySemanticApi, type OxyStorageApi, type OxyTransaction, type OxyWarehouseApi, PeerCohortClient, type PeerCohortResult, type PredictChange, type PredictImpact, type PredictOptions, type PredictResult, type ProcedureProgress, type ProcedureResult, type ProcedureRunState, type ProjectionGranularity, type ProjectionRequest, type ProjectionResponse, type ResolvedCustomAppManifest, type ScanFailure, type ScanOptions, type ScanResponse, type SegmentOpportunity, type SemanticArrayOp, type SemanticDateRangeOp, type SemanticFilter, type SemanticScalarOp, type SemanticTimeDimension, type SensitivityDriver, type SensitivityResult, type SizeOpts, type SkippedDimension, type SplitKind, type StorageDownloadUrl, type StorageListPage, type StorageObject, type StoragePutOptions, type StoragePutResult, type StorageUploadUrl, type StorageUploadUrlInput, type TimeDimensionsResponse, type UnvaluedNode, type UseAgentRunInput, type UseAgentRunResult, type UseFunctionResult, type UseMeasureBreakdownResult, type UseMetricTreeOpts, type UsePredictOpts, type UseProcedureRunInput, type UseProcedureRunOpts, type UseProcedureRunResult, type UseQueryInput, type UseQueryOpts, type UseQueryResult, type UseSemanticQueryInput, type UseSemanticQueryOpts, type UseSemanticQueryResult, type UseWorldModelGraphResult, type UseWorldModelInstancesOpts, type UseWorldModelInstancesResult, type WmBreakdownEdge, type WmBreakdownNode, type WmEntityCount, type WmFilterCountsResponse, type WmInstance, type WmInstancesResponse, type WmMeasureBreakdown, type WmMeasureBreakdownEvent, type WorldModel, type WorldModelApi, type WorldModelDimension, type WorldModelEdge, type WorldModelEntity, type WorldModelInducedMeasure, type WorldModelMeasure, WorldModelScopeUnsupportedError, _resetCustomAppManifestCacheForTest, apiErrorFromResponse, base64ToBytes, bytesToBase64, createWorldModel, getCustomAppDebug, getOxyAppLogger, interpretCustomAppError, loadCustomAppManifest, readInjectedAppConfig, readJsonSseStream, setOxyAppLogger, useAgentRun, useBaseline, useDistribution, useExplain, useFunction, useMeasureBreakdown, useMetricTree, useOpportunity, useOxyApp, usePredict, useProcedureRun, useProjection, useQuery, useResolvedManifest, useSemanticQuery, useSensitivity, useTimeDimensions, useTrackEvent, useWorldModel, useWorldModelGraph, useWorldModelInstances };
|
|
1436
1597
|
//# sourceMappingURL=index.d.mts.map
|
package/dist/index.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/config.ts","../src/metricTree.ts","../src/anomalies.ts","../src/custom-app/base64.ts","../src/custom-app/debug.ts","../src/custom-app/inject.ts","../src/custom-app/logger.ts","../src/custom-app/metric-tree-hooks.tsx","../src/custom-app/sse.ts","../src/worldModel.ts","../src/custom-app/world-model-hooks.tsx","../src/custom-app/world-node.tsx"],"mappings":";;;;;;;UAGiB;;;;EAIf;;;;EAKA;;;;EAKA;;;;EAKA;;;;EAKA;;;;;;;EAQA;;;;;EAMA;;;;
|
|
1
|
+
{"version":3,"file":"index.d.mts","names":[],"sources":["../src/config.ts","../src/peerCohort.ts","../src/metricTree.ts","../src/anomalies.ts","../src/custom-app/base64.ts","../src/custom-app/debug.ts","../src/custom-app/inject.ts","../src/custom-app/logger.ts","../src/custom-app/metric-tree-hooks.tsx","../src/custom-app/sse.ts","../src/worldModel.ts","../src/custom-app/world-model-hooks.tsx","../src/custom-app/world-node.tsx"],"mappings":";;;;;;;UAGiB;;;;EAIf;;;;EAKA;;;;EAKA;;;;EAKA;;;;EAKA;;;;;;;EAQA;;;;;EAMA;;;;;;KC/BU;;;;;;;;;UAUK;;;EAGf;;;EAGA;;;;;;;;;;;;UAae;EACf;EACA;;;;EAIA;;;;EAIA;;;EAGA;EACA;;;EAGA;;;;;;UAOe;EACf;EACA;EACA;EACA,WAAW;;EAEX;;;;;;;;;;;;;EAaA;EACA,UAAU;EACV,UAAU;;;;;;;UAQK;;;;;;;;;EASf;EACA;EACA;;EAEA;;EAEA;;EAEA;;;;;;;KAUU,eAAa,GAAG,kBAAkB,UAAU,gBAAgB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;cAwBnE;mBACM;mBACA;EAEjB,YAAY,QAAQ,WAAW,SAAS;UAKhC;UAIA;;;;;;;;;;;;;;EAoBF,QAAQ,SAAS,gBAAgB,QAAQ;;;;KCvKrC;KACA;KACA;KACA;;;;;;;;;KASA;UAWK;EACf;EACA;EACA;EACA;EACA;EACA;EACA;;;;;EAKA;EACA;;UAGe;EACf;EACA;EACA,MAAM;;EAEN;;;;;EAKA;EACA,WAAW;EACX,UAAU;EACV,YAAY;EACZ;EACA,MAAM;;EAEN;EACA;EACA;EACA;EACA;;UAGe;EACf,OAAO;EACP,OAAO;EACP;;;;EAIA;;UAKe;EACf;EACA;EACA;EACA;EACA,OAAO;EACP,WAAW;EACX,UAAU;EACV;EACA;;UAGe;EACf;EACA,SAAS;;UAKM;EACf;EACA;;UAGe;EACf;EACA;EACA;EACA;EACA,MAAM;EACN;;UAGe;EACf,QAAQ;EACR,SAAS;;;KAIC,gBAAgB;;;;;;;;UASX;EACf;EACA;EACA;;;;EAIA,OAAO;;;;;;;;;EASP;EACA;EACA;;;;EAIA;;;EAGA;EACA;;EAEA;;EAEA;;;;EAIA;;;;EAIA;IAAY;IAAY;IAAa;;;;EAGrC;;;;;EAKA;EACA;;;;EAIA;IAAe,MAAM;IAAY;IAAa;;EAC9C;;;UAIe;EACf;EACA;;;;UAKe;EACf;;EAEA;;UAGe;;;EAGf;EACA;;EAEA;EACA,WAAW;;UAGI;EACf,QAAQ;EACR,UAAU;EACV;;;EAGA;;;EAGA,SAAS;;UAGM;;;EAGf,SAAS;;EAET,eAAe;;KAKL;;;;;;;;;;;UAYK;;;EAGf;EACA;;EAEA;;;EAGA,WAAW;;EAEX,cAAc;;;;EAId;;;;;;;EAOA;;UAGe;;EAEf;EACA;;UAGe;EACf;EACA;;;;EAIA;EACA;;;;;;;;UASe;EACf;EACA,SAAS;EACT,UAAU;EACV;;;EAGA;;UAGe;EACf,aAAa;;EAEb;EACA;EACA,QAAQ;;;;EAIR;;KAKU;EACN;EAAmB;;EACnB;EAAmB;EAAmB;;EACtC;EAA6B;EAAmB;;EAChD;EAAuB;EAAmB;EAAe;;UAE9C;EACf,OAAO;EACP;EACA;EACA;;UAGe;EACf,OAAO;EACP;EACA;EACA;EACA;EACA;EACA,WAAW;EACX;EACA,WAAW;;;;;;;KAQD;;;;;UAMK;EACf;EACA;EACA;EACA;EACA;;UAGe;EACf;EACA;EACA;EACA;;;EAGA,YAAY;EACZ,eAAe;EACf;EACA,MAAM;;EAEN;EACA;EACA,cAAc;;KAGJ;EAEN;EACA;EACA;EACA;;EAGA;EACA;EACA;EACA;EACA;;EAGA;EACA;EACA;EACA;;UAGW;EACf;EACA;EACA;;UAGe;EACf;EACA;EACA;EACA;EACA,SAAS;;UAGM;EACf;EACA;EACA;EACA;EACA;EACA;EACA;EACA,OAAO;EACP;EACA,qBAAqB;EACrB;EACA,WAAW;;UAKI;EACf;EACA;EACA;EACA;EACA;;EAEA;;UAGe;EACf;EACA;;EAEA;EACA;EACA,UAAU;EACV;;UAGe;EACf;EACA;;UAGe;EACf;EACA;EACA;;;;;;;;;;;EAWA,YAAY;;UAGG;EACf;EACA;EACA;;;;;EAKA;EACA,YAAY;EACZ,oBAAoB;EACpB,YAAY;;;;;;;;UAWG;EACf;EACA;;EAEA;;UAKe;;EAEf,SAAS;;;;;;;KAUC,eAAa,GAAG,kBAAkB,UAAU,gBAAgB,QAAQ;;;;;;;;;;;;;;;;;cAkBnE;mBACM;mBACA;EAEjB,YAAY,QAAQ,WAAW,SAAS;UAKhC;UAIA;;;;;;;;;;;;;EAmBF,QAAQ,gBAAgB,QAAQ;;;;;;;;;;;;;;EAkBhC,eAAe,oBAAoB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkC3C,YAAY,SAAS,kBAAkB,QAAQ;;;;;;;;;;;;;;;;;;;EA0B/C,QAAQ,SAAS,iBAAiB,UAAS,iBAAsB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4CzE,cAAc,SAAS,oBAAoB,QAAQ;;;;;;;;;;;;;;;EAsBnD,QAAQ,SAAS,iBAAiB,QAAQ;;;;;;;;;;;;;;;;;EAwB1C,kBAAkB,SAAS,qBAAqB,QAAQ;;;;KCntBpD;KACA;;UAGK;;EAEf;;EAEA;;;;;;;UAQe;EACf;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA,UAAU;EACV,QAAQ;EACR;;;;;EAKA;;;;;;;EAOA,SAAS;;;;;;;;EAQT;;EAEA,gBAAgB;EAChB;EACA;EACA;;UAGe;EACf,SAAS;;;;;;EAMT;;;;;;;;;;EAUA;;;;;EAKA;;UAGe;EACf,WAAW;;;;;;;;;;;;;;;;;;;;EAoBX;;;;;;;;;;;;EAYA;EACA;;;;;;EAMA;;;;;;;;;;;;;;EAcA;;UAGe;;;EAGf;;;;;;;;;;EAUA;;UAGe;;EAEf;;;UAIe;EACf;EACA;EACA;EACA;;EAEA;;EAEA,SAAS;EACT;;UAGe;EACf;EACA;EACA;;;;;;;EAOA;;;;;EAKA,UAAU;;UAGK;;EAEf;;KAKU,aAAa,GAAG,kBAAkB,UAAU,gBAAgB,QAAQ;;;;;;;;;;;;;;cAsBnE;mBACM;mBACA;EAEjB,YAAY,QAAQ,WAAW,SAAS;UAKhC;UAIA;;;;;;;;;;;;;;;EAqBF,KAAK,UAAS,uBAA4B,QAAQ;;;;;;;;;;;;;;;;;;;;;;EAqClD,KAAK,UAAS,cAAmB,QAAQ;;;;EAWzC,aAAa,mBAAmB,QAAQ,gBAAgB,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0ChE,iBACJ;IAAU;IAAgB;IAAqB,eAAe;KAC9D,QAAQ,gBACP,QAAQ;;;;;;;;;;EA6BL,QAAQ,mBAAmB,UAAS,iBAAsB,QAAQ;;;;;;;;;;;;;;;;;;;;iBChV1D,cAAc,OAAO,aAAa,cAAc;;;;;;;;iBA8BhD,cAAc,iBAAiB;;;;;;UC9D9B;EACf;EACA;EACA;IACE;IACA;IACA;IACA;IACA;IACA;IACA;;EAEF;EACA;;EAEA,UAAU;EACV;EACA,UAAU;IAAQ;IAAc;;;;;;;;;iBASZ,kBACpB,UAAU,4BACT,QAAQ;;;;;;;;UCnCM;EACf;EACA;EACA;EACA;EACA;EACA;;EAEA;;QAGM;YACI;IACR,cAAc;;;;;;;;;iBAUF,yBAAyB;;;KCpB7B;UAEK;EACf,IAAI,OAAO,gBAAgB,aAAa,MAAM;;;iBAMhC,gBAAgB,QAAQ;;iBAKxB,mBAAmB;;;;UCSlB,qBAAqB;EACpC,MAAM;EACN;EACA,OAAO;;EAEP;;UAGQ;;EAER;;UA+De,0BAA0B;;EAEzC;;;;;;;iBAQc,cAAc,OAAM,oBAAyB,qBAAqB;;;;;iBAsBlE,eACd,0BACA,OAAM,eACL,qBAAqB;UAmBP,uBAAuB,cAAc;;;;;;;;;;;;;iBActC,WACd,SAAS,wBACT,OAAM,iBACL,qBAAqB;;;;;;;;;;;;;;iBA0CR,YACd,SAAS,wBACT,OAAM,eACL,qBAAqB;;;;;;;;;;;;;;iBAiCR,cACd,SAAS,0BACT,OAAM,eACL,qBAAqB;;;;;;;iBA0BR,WACd,SAAS,uBACT,OAAM,eACL,qBAAqB;;;;;;iBAyBR,gBACd,SAAS,4BACT,OAAM,eACL,qBAAqB;;;;;;;iBA0BR,eACd,SAAS,2BACT,OAAM,eACL,qBAAqB;;;;;;iBAyBR,kBACd,OAAM,eACL,qBAAqB;;;;;;;;iBCzWF,kBAAkB,GACtC,MAAM,UACN,UAAU,OAAO,aAChB;;;;KCNS;UAEK;EACf;EACA;EACA,YAAY;EACZ;EACA;EACA;;EAEA;;;UAIe,iCAAiC;;EAEhD;;EAEA;;UAGe;EACf;EACA;EACA;EACA;;UAGe;EACf;EACA;EACA;EACA;EACA;EACA,YAAY;EACZ,cAAc;EACd,kBAAkB;EAClB;;;UAIe;EACf;EACA;EACA;;UAGe;EACf,UAAU;EACV,OAAO;;UAKQ;EACf;EACA;;;;;EAKA;IAAa;IAAY;IAAc;IAAsB;;;UAG9C;EACf;EACA;EACA,OAAO;;UAKQ;EACf;EACA;;EAEA;;EAEA;;UAGe;EACf,QAAQ,eAAe;;UAKR;;EAEf;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;EAEA;EACA;;UAGe;EACf;EACA;EACA;EACA;;;;KAKU;EAEN;EACA;EACA,OAAO,KAAK;EACZ,OAAO;;EAEP;EAAe;EAAiB;EAAsB;;EACtD;;;;UAIW;EACf;EACA,OAAO;EACP,OAAO;;;;UC9GQ;EACf,MAAM;EACN;EACA,OAAO;EACP;;;;;;;;;;;;iBAac,mBAAmB;EAAQ;IAA2B;UA6CrD;;EAEf;;EAEA;EACA;;;;;;;;EAQA;;UAGe;EACf,MAAM;EACN;EACA,OAAO;EACP;;;;;;;iBAQc,uBACd,yBACA,OAAM,6BACL;UAwDc;;EAEf,WAAW;EACX;EACA;EACA,OAAO;;;;;;;;iBAmCO,oBACd,yBACA,yBACA,yBACC;;;;KClLS,cAAc,SAAS;;;KAIvB,cAAc,KAAK;;;KAInB,WAAW,KAAK;;;UAIX;;EAEf,MAAM;;EAEN,MAAM;;EAEN,QAAQ;;;;;;;UAQO;;WAEN;;WAEA,OAAO;;EAEhB,KAAK,SAAS,cAAc,QAAQ;;EAEpC,OAAO,SAAS,cAAc,QAAQ;;EAEtC,QAAQ,SAAS,cAAc,QAAQ;;EAEvC,QAAQ,MAAM,aAAa,SAAS,cAAc,QAAQ;;EAE1D,KAAK,MAAM,UAAU,SAAS,cAAc,QAAQ;;EAEpD,MAAM,OAAO,yBAAyB;;;;;;;UAQvB;;WAEN;;EAET,KAAK,eAAe,SAAS,cAAc,QAAQ;;EAEnD,OAAO,aAAa;;;;;;;;cAST,wCAAwC;WAC1C;WACA,OAAO;EAChB,YAAY,cAAc,OAAO;;;;;;;iBAkBnB,iBAAiB,0BAA0B,SAAS,aAAa;;;;;;;;;;;;;;;;;;;;;;iBAqGjE,iBAAiB"}
|
package/dist/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// @oxy/sdk - TypeScript SDK for Oxy data platform
|
|
2
|
-
import { _ as interpretCustomAppError, a as useFunction, c as useQuery, d as useTrackEvent, f as _resetCustomAppManifestCacheForTest, g as apiErrorFromResponse, h as OxyApiError, i as useAgentRun, l as useResolvedManifest, m as readInjectedAppConfig, n as OxyAppProvider, o as useOxyApp, p as loadCustomAppManifest, r as OxyChat, s as useProcedureRun, t as OxyAnswer, u as useSemanticQuery, v as getOxyAppLogger, y as setOxyAppLogger } from "./react-
|
|
2
|
+
import { _ as interpretCustomAppError, a as useFunction, c as useQuery, d as useTrackEvent, f as _resetCustomAppManifestCacheForTest, g as apiErrorFromResponse, h as OxyApiError, i as useAgentRun, l as useResolvedManifest, m as readInjectedAppConfig, n as OxyAppProvider, o as useOxyApp, p as loadCustomAppManifest, r as OxyChat, s as useProcedureRun, t as OxyAnswer, u as useSemanticQuery, v as getOxyAppLogger, y as setOxyAppLogger } from "./react-Cq3xULOr.mjs";
|
|
3
3
|
import * as React from "react";
|
|
4
4
|
|
|
5
5
|
//#region src/anomalies.ts
|
|
@@ -1085,5 +1085,65 @@ var MetricTreeClient = class {
|
|
|
1085
1085
|
};
|
|
1086
1086
|
|
|
1087
1087
|
//#endregion
|
|
1088
|
-
|
|
1088
|
+
//#region src/peerCohort.ts
|
|
1089
|
+
/**
|
|
1090
|
+
* Client for the `/semantic/cohort` endpoint. Surfaces airlayer's peer-cohort
|
|
1091
|
+
* benchmarking — comparing an entity's subjects against their declared peers
|
|
1092
|
+
* on a measure, with exclusions explained rather than silently dropped.
|
|
1093
|
+
*
|
|
1094
|
+
* Construction is internal to {@link OxyClient} — call `client.peerCohort`
|
|
1095
|
+
* to access an instance rather than building one yourself.
|
|
1096
|
+
*
|
|
1097
|
+
* @example
|
|
1098
|
+
* ```typescript
|
|
1099
|
+
* const client = await OxyClient.create({ projectId: "...", apiKey: "..." });
|
|
1100
|
+
* const result = await client.peerCohort.resolve({
|
|
1101
|
+
* entity: "restaurant_id",
|
|
1102
|
+
* measure: "orders.net_revenue",
|
|
1103
|
+
* time_dimension: "orders.order_date",
|
|
1104
|
+
* period: ["2025-09-01", "2025-09-30"],
|
|
1105
|
+
* });
|
|
1106
|
+
* for (const excluded of result.excluded) {
|
|
1107
|
+
* console.warn(excluded.key, excluded.reason);
|
|
1108
|
+
* }
|
|
1109
|
+
* ```
|
|
1110
|
+
*/
|
|
1111
|
+
var PeerCohortClient = class {
|
|
1112
|
+
constructor(config, request) {
|
|
1113
|
+
this.config = config;
|
|
1114
|
+
this.request = request;
|
|
1115
|
+
}
|
|
1116
|
+
path(suffix) {
|
|
1117
|
+
return `/${this.config.projectId}${suffix}`;
|
|
1118
|
+
}
|
|
1119
|
+
buildQuery(extra = {}) {
|
|
1120
|
+
const params = { ...extra };
|
|
1121
|
+
if (this.config.branch) params.branch = this.config.branch;
|
|
1122
|
+
const qs = new URLSearchParams(params).toString();
|
|
1123
|
+
return qs ? `?${qs}` : "";
|
|
1124
|
+
}
|
|
1125
|
+
/**
|
|
1126
|
+
* Resolve a subject's peer cohort and every peer's comparison against it.
|
|
1127
|
+
*
|
|
1128
|
+
* @example
|
|
1129
|
+
* ```typescript
|
|
1130
|
+
* const result = await client.peerCohort.resolve({
|
|
1131
|
+
* entity: "restaurant_id",
|
|
1132
|
+
* measure: "orders.net_revenue",
|
|
1133
|
+
* time_dimension: "orders.order_date",
|
|
1134
|
+
* period: ["2025-09-01", "2025-09-30"],
|
|
1135
|
+
* });
|
|
1136
|
+
* ```
|
|
1137
|
+
*/
|
|
1138
|
+
async resolve(request) {
|
|
1139
|
+
const query = this.buildQuery();
|
|
1140
|
+
return this.request(this.path(`/semantic/cohort${query}`), {
|
|
1141
|
+
method: "POST",
|
|
1142
|
+
body: JSON.stringify(request)
|
|
1143
|
+
});
|
|
1144
|
+
}
|
|
1145
|
+
};
|
|
1146
|
+
|
|
1147
|
+
//#endregion
|
|
1148
|
+
export { AnomaliesClient, MetricTreeClient, OxyAnswer, OxyApiError, OxyAppProvider, OxyChat, PeerCohortClient, WorldModelScopeUnsupportedError, _resetCustomAppManifestCacheForTest, apiErrorFromResponse, base64ToBytes, bytesToBase64, createWorldModel, getCustomAppDebug, getOxyAppLogger, interpretCustomAppError, loadCustomAppManifest, readInjectedAppConfig, readJsonSseStream, setOxyAppLogger, useAgentRun, useBaseline, useDistribution, useExplain, useFunction, useMeasureBreakdown, useMetricTree, useOpportunity, useOxyApp, usePredict, useProcedureRun, useProjection, useQuery, useResolvedManifest, useSemanticQuery, useSensitivity, useTimeDimensions, useTrackEvent, useWorldModel, useWorldModelGraph, useWorldModelInstances };
|
|
1089
1149
|
//# sourceMappingURL=index.mjs.map
|