@oxy-hq/sdk 2.5.0 → 2.6.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.
@@ -1,6 +1,6 @@
1
1
 
2
2
  import * as React from "react";
3
- //#region src/customer-app/manifest.d.ts
3
+ //#region src/custom-app/manifest.d.ts
4
4
  /**
5
5
  * Declaration of a single Oxy Function shipped in the bundle's
6
6
  * `functions/` dir. See `internal-docs/2026-06-12-customer-apps-functions-design.md`.
@@ -136,7 +136,7 @@ interface OxyAppManifest {
136
136
  * should treat this as the only source of truth for "which org/app
137
137
  * does this bundle belong to."
138
138
  */
139
- interface ResolvedCustomerAppManifest {
139
+ interface ResolvedCustomAppManifest {
140
140
  manifest: OxyAppManifest;
141
141
  /**
142
142
  * Always an empty array for v2 manifests. Kept for API compatibility;
@@ -179,13 +179,13 @@ interface LoadManifestOptions {
179
179
  * Load + validate the manifest. Cached after the first call so callers
180
180
  * can invoke this from every component without coordinating.
181
181
  */
182
- declare function loadCustomerAppManifest(options?: LoadManifestOptions): Promise<ResolvedCustomerAppManifest>;
182
+ declare function loadCustomAppManifest(options?: LoadManifestOptions): Promise<ResolvedCustomAppManifest>;
183
183
  /** For tests: reset the cache between runs. */
184
- declare function _resetCustomerAppManifestCacheForTest(): void;
184
+ declare function _resetCustomAppManifestCacheForTest(): void;
185
185
  //#endregion
186
- //#region src/customer-app/errors.d.ts
186
+ //#region src/custom-app/errors.d.ts
187
187
  /**
188
- * Error thrown by all customer-app hooks when an API call returns a
188
+ * Error thrown by all custom-app hooks when an API call returns a
189
189
  * non-2xx response. Carries the structured `code` + `hint` the server
190
190
  * emits so bundle UIs can render an actionable message instead of
191
191
  * "404: { ...json... }".
@@ -208,23 +208,23 @@ declare class OxyApiError extends Error {
208
208
  * dominate the bundle UI).
209
209
  */
210
210
  declare function apiErrorFromResponse(resp: Response): Promise<OxyApiError>;
211
- interface CustomerAppErrorReport {
211
+ interface CustomAppErrorReport {
212
212
  title: string;
213
213
  message: string;
214
214
  hint: string;
215
215
  docs?: string;
216
216
  }
217
217
  /** Interpret a thrown error as a structured report for UI display. */
218
- declare function interpretCustomerAppError(err: unknown): CustomerAppErrorReport;
218
+ declare function interpretCustomAppError(err: unknown): CustomAppErrorReport;
219
219
  //#endregion
220
- //#region src/customer-app/function-sse.d.ts
220
+ //#region src/custom-app/function-sse.d.ts
221
221
  /** A captured `console.*` / `ctx.log` line from a function run. */
222
222
  interface FunctionLog {
223
223
  level: string;
224
224
  message: string;
225
225
  }
226
226
  //#endregion
227
- //#region src/customer-app/react.d.ts
227
+ //#region src/custom-app/react.d.ts
228
228
  /**
229
229
  * Credentialed fetch wrapper stored in context so `useQuery` can share
230
230
  * the same request mechanism without coupling it to the global `fetch`.
@@ -237,7 +237,7 @@ interface FunctionLog {
237
237
  */
238
238
  type AppFetcher = typeof fetch;
239
239
  interface OxyAppProviderProps {
240
- /** Optional manifest load options. Same shape as `loadCustomerAppManifest`. */
240
+ /** Optional manifest load options. Same shape as `loadCustomAppManifest`. */
241
241
  manifestOptions?: LoadManifestOptions;
242
242
  /**
243
243
  * Rendered while the manifest is loading. Defaults to nothing; pass a
@@ -249,7 +249,7 @@ interface OxyAppProviderProps {
249
249
  * report so the bundle can show its own branded error card. Defaults
250
250
  * to a minimal text-only fallback (better than a blank page).
251
251
  */
252
- errorFallback?: (err: CustomerAppErrorReport) => React.ReactNode;
252
+ errorFallback?: (err: CustomAppErrorReport) => React.ReactNode;
253
253
  /**
254
254
  * Override the fetch implementation used by all hooks (`useQuery`).
255
255
  * Useful for test environments or proxy setups. Defaults to a wrapper
@@ -278,7 +278,7 @@ declare function OxyAppProvider(props: OxyAppProviderProps): React.JSX.Element;
278
278
  * `<OxyAppProvider>` — that's a programmer error worth surfacing
279
279
  * loudly, not silently swallowing.
280
280
  */
281
- declare function useResolvedManifest(): ResolvedCustomerAppManifest;
281
+ declare function useResolvedManifest(): ResolvedCustomAppManifest;
282
282
  /**
283
283
  * Low-level hook that returns the raw context value (including the
284
284
  * fetcher). Prefer `useResolvedManifest` for manifest access; use
@@ -310,7 +310,7 @@ interface UseQueryResult<Row = Record<string, unknown>> {
310
310
  }
311
311
  /**
312
312
  * Execute an ad-hoc SQL query against the project linked to this
313
- * customer app. The query is specified inline by the caller; no
313
+ * custom app. The query is specified inline by the caller; no
314
314
  * manifest declaration is involved.
315
315
  *
316
316
  * Re-runs whenever `input` or enabled `params` change. Use the
@@ -652,5 +652,5 @@ interface OxyChatProps {
652
652
  */
653
653
  declare function OxyChat(props: OxyChatProps): React.JSX.Element;
654
654
  //#endregion
655
- export { UseSemanticQueryOpts as A, CustomerAppErrorReport as B, UseProcedureRunInput as C, UseQueryOpts as D, UseQueryInput as E, useProcedureRun as F, OxyAppFunctionManifest as G, apiErrorFromResponse as H, useQuery as I, _resetCustomerAppManifestCacheForTest as J, OxyAppManifest as K, useResolvedManifest as L, useAgentRun as M, useFunction as N, UseQueryResult as O, useOxyApp as P, useSemanticQuery as R, UseFunctionResult as S, UseProcedureRunResult as T, interpretCustomerAppError as U, OxyApiError as V, LoadManifestOptions as W, loadCustomerAppManifest as Y, SemanticFilter as _, AppFetcher as a, UseAgentRunInput as b, OxyAppProvider as c, OxyChatProps as d, ProcedureProgress as f, SemanticDateRangeOp as g, SemanticArrayOp as h, AgentSqlArtifact as i, UseSemanticQueryResult as j, UseSemanticQueryInput as k, OxyAppProviderProps as l, ProcedureRunState as m, AgentRunEvent as n, OxyAnswer as o, ProcedureResult as p, ResolvedCustomerAppManifest as q, AgentRunState as r, OxyAnswerProps as s, AgentArtifact as t, OxyChat as u, SemanticScalarOp as v, UseProcedureRunOpts as w, UseAgentRunResult as x, SemanticTimeDimension as y, useTrackEvent as z };
656
- //# sourceMappingURL=react-BnpR8VRJ.d.cts.map
655
+ export { UseSemanticQueryOpts as A, CustomAppErrorReport as B, UseProcedureRunInput as C, UseQueryOpts as D, UseQueryInput as E, useProcedureRun as F, OxyAppFunctionManifest as G, apiErrorFromResponse as H, useQuery as I, _resetCustomAppManifestCacheForTest as J, OxyAppManifest as K, useResolvedManifest as L, useAgentRun as M, useFunction as N, UseQueryResult as O, useOxyApp as P, useSemanticQuery as R, UseFunctionResult as S, UseProcedureRunResult as T, interpretCustomAppError as U, OxyApiError as V, LoadManifestOptions as W, loadCustomAppManifest as Y, SemanticFilter as _, AppFetcher as a, UseAgentRunInput as b, OxyAppProvider as c, OxyChatProps as d, ProcedureProgress as f, SemanticDateRangeOp as g, SemanticArrayOp as h, AgentSqlArtifact as i, UseSemanticQueryResult as j, UseSemanticQueryInput as k, OxyAppProviderProps as l, ProcedureRunState as m, AgentRunEvent as n, OxyAnswer as o, ProcedureResult as p, ResolvedCustomAppManifest as q, AgentRunState as r, OxyAnswerProps as s, AgentArtifact as t, OxyChat as u, SemanticScalarOp as v, UseProcedureRunOpts as w, UseAgentRunResult as x, SemanticTimeDimension as y, useTrackEvent as z };
656
+ //# sourceMappingURL=react-DnBdQ8dG.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"react-DnBdQ8dG.d.mts","names":[],"sources":["../src/custom-app/manifest.ts","../src/custom-app/errors.ts","../src/custom-app/function-sse.ts","../src/custom-app/react.tsx"],"mappings":";;;;;;;;;;;UA0BiB;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA;IAAe;IAAkB;;;EAEjC;;;;;;;;;EASA;IAAU;;;;;;;;;;EASV;;;;;;;EAOA;IAAY;;;;;;;;;EAQZ;IAAU;;;;;;;;;;EASV;IAAY;IAAsB;IAAuB;;;;;;;;EAOzD;;;UAIe;;EAEf;;;;;;EAMA;;;;;;;EAOA;;;;;;EAMA;;;;;;EAMA;;;;;;EAMA,YAAY,eAAe;;;;;;;EAO3B;IAAQ;IAAgB;;;;;;;;UAUT;EACf,UAAU;;;;;;;EAOV;;EAEA;;EAEA;;;;;;EAMA;;EAEA;;;;;;;;EAQA;;UAGe;;;;;;;EAOf;;;;;;iBASc,sBACd,UAAS,sBACR,QAAQ;;iBAQK;;;;;;;;;cC9KH,oBAAoB;WACtB;WACA;WACA;EACT,YAAY;IACV;IACA;IACA;IACA;;;;;;;;;iBAmBkB,qBAAqB,MAAM,WAAW,QAAQ;UA2BnD;EACf;EACA;EACA;EACA;;;iBAMc,wBAAwB,eAAe;;;;UC7EtC;EACf;EACA;;;;;;;;;;;;;;KC4CU,oBAAoB;UAsCf;;EAEf,kBAAkB;;;;;EAKlB,WAAW,MAAM;;;;;;EAMjB,iBAAiB,KAAK,yBAAyB,MAAM;;;;;;EAMrD,UAAU;;;;;;;;;;EAUV;EACA,UAAU,MAAM;;;;;;iBAOF,eAAe,OAAO,sBAAsB,MAAM,IAAI;;;;;;iBA0GtD,uBAAuB;;;;;;;;iBAqBvB;EACd;EACA;EACA;EACA,SAAS;;UAgBM;EACf;EACA;;UAGe;EACf,SAAS;;EAET;;UAGe,eAAe,MAAM;EACpC,MAAM;EACN;EACA;EACA,OAAO;EACP;;;;;;;;;;;iBAYc,SAAS,MAAM,yBAC7B,OAAO,eACP,OAAM,eACL,eAAe;UAwFD,kBAAkB;;;;;;;;EAQjC,SAAS,gBAAgB;IAAS;QAA8B,QAAQ;;EAExE,MAAM;;EAEN;;EAEA,OAAO;;;;;;;EAOP,MAAM;;;;;;;;;;;;iBAaQ,YAAY,gBAAgB,eAAe,kBAAkB;;KAoFjE;;KAGA;;KAGA;;;;;;;;KASA;EACN;EAAe,IAAI;EAAkB;;EACrC;EAAe,IAAI;EAAiB,QAAQ;;EAC5C;EAAe,IAAI;EAAqB;EAAc;;;UAG3C;EACf;EACA;;UAGe;EACf;EACA;EACA;EACA,kBAAkB;EAClB,UAAU;EACV;;UAGe;;EAEf;;;;;;;EAOA;;UAGe,uBAAuB,MAAM;EAC5C,MAAM;EACN;;EAEA;;EAEA;EACA;EACA,OAAO;EACP;;;;;;;;;;;;iBAac,iBAAiB,MAAM,yBACrC,OAAO,uBACP,OAAM,uBACL,uBAAuB;KAoHd;UAEK;EACf;;UAGe;;;EAGf;EACA;;EAEA;;UAGe;EACf;EACA;;UAGe;EACf;EACA,SAAS;;UAGM;EACf,OAAO;EACP,MAAM,SAAS;;EAEf;EACA,UAAU;EACV,QAAQ;EACR,OAAO;;;;;;;;;;;;;;;;;;;;iBAyBO,gBACd,OAAO,sBACP,OAAM,sBACL;KAsLS;UAEK;EACf;EACA;;;;;;UAOe;EACf;;;EAGA;;;EAGA;EACA;;EAEA;IACE;IACA;IACA;;;;;EAKF;;KAGU,gBAAgB;UAEX;EACf;;UAGe;EACf,OAAO;;EAEP,MAAM,kBAAkB;IAAS;;;EAEjC;;EAEA,QAAQ;;;;EAIR,WAAW;;EAEX;;EAEA;;EAEA;;;;;;;;;;;;;;;;;;;EAmBA;EACA,OAAO;;iBAGO,YAAY,OAAO,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2hBtC,kBAAkB,cAAc,UAAU;UA6GzC;;EAEf;;EAEA,YAAY;;EAEZ,OAAO;;EAEP;;EAEA,QAAQ;;;;;;;;EAQR;;EAEA;;;EAGA;;EAEA;;;;;;;;;;;;;;;;;;;iBAoBc,UAAU,OAAO,iBAAiB,MAAM,IAAI;UAgE3C;;EAEf;;EAEA;;EAEA;;EAEA,aAAa,MAAM;;EAEnB;;EAEA;;;;;;;;;;;;;;iBAec,QAAQ,OAAO,eAAe,MAAM,IAAI"}
package/dist/shell.cjs CHANGED
@@ -1,6 +1,6 @@
1
1
  // @oxy/sdk - TypeScript SDK for Oxy data platform
2
2
  Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
3
- const require_react = require('./react-BeweGSYF.cjs');
3
+ const require_react = require('./react-BAiiXftp.cjs');
4
4
  let react = require("react");
5
5
  react = require_react.__toESM(react, 1);
6
6
  let react_jsx_runtime = require("react/jsx-runtime");
@@ -1784,7 +1784,7 @@ function ShellRail({ top, groups, footerItems, bottom, className }) {
1784
1784
  //#endregion
1785
1785
  //#region src/shell/shellContext.ts
1786
1786
  /**
1787
- * Fetch the shell bootstrap payload for the current customer app. Must be
1787
+ * Fetch the shell bootstrap payload for the current custom app. Must be
1788
1788
  * called inside `<OxyAppProvider>`. Failure is non-fatal by design: the
1789
1789
  * shell degrades to chrome-less rendering (older servers don't have the
1790
1790
  * endpoint), so errors are surfaced on the result, never thrown.
@@ -2051,7 +2051,7 @@ function buildRailGroups(data, currentAppSlug, abs) {
2051
2051
  return appItems.length ? [[hq, chat], appItems] : [[hq, chat]];
2052
2052
  }
2053
2053
  /**
2054
- * The workspace chrome around a customer app: icon rail + universal top bar
2054
+ * The workspace chrome around a custom app: icon rail + universal top bar
2055
2055
  * + content column — visually identical to the main web-app shell.
2056
2056
  */
2057
2057
  function OxyShell({ children, pageLabel, topBarLeft, topBarExtra, railBottom, hideTopBar, askHotkey = true, productBaseUrl, className, chromeBackground, chromeForeground }) {