@relyio/sdk 0.4.0 → 0.5.0

package/dist/{index-DFehx5sI.d.cts → index-C5mRBb6t.d.cts}

@@ -574,6 +574,26 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    '/v1/project': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Describe the key's project
+         * @description The organization, project, dataset and branch this key resolves to, each with its id and name, and `studioUrl` — the Studio root for the project, built from ids. `dataset` is the one this request selected (`X-RelyIO-Dataset`, or the key’s default), which is not always the project’s default: a Studio link should carry it as `?dataset=`. `studioUrl` is `null` when the service has no Dashboard address configured. Never cached.
+         */
+        get: operations['getProject'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/v1/query': {
         parameters: {
             query?: never;
@@ -863,6 +883,28 @@ interface components {
             limit: number;
             total: number;
         };
+        /** @description The place this key resolves to, named, and the Studio root for its project. `id` and `name` are the project’s. */
+        Project: {
+            id: string;
+            name: string;
+            /** @description The organization that owns the project. */
+            organization: {
+                id: string;
+                name: string;
+            };
+            /** @description The dataset this request was answered from — the one `X-RelyIO-Dataset` selected, or the key’s default. */
+            dataset: {
+                id: string;
+                name: string;
+            };
+            /** @description The branch that dataset is assigned to. */
+            branch: {
+                id: string;
+                name: string;
+            };
+            /** @description `<dashboard>/o/<organization id>/<project id>/studio`, or null when the service has no Dashboard address configured. */
+            studioUrl: string | null;
+        };
         RefusalAccessDenied: {
             error: {
                 /** @enum {string} */
@@ -4227,6 +4269,92 @@ interface operations {
             };
         };
     };
+    getProject: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Success. */
+            200: {
+                headers: {
+                    'Cache-Control'?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        data: components['schemas']['Project'];
+                    };
+                };
+            };
+            /** @description REQUEST_INVALID */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalRequestInvalid'];
+                };
+            };
+            /** @description INVALID_API_KEY, MISSING_API_KEY */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalInvalidApiKeyOrMissingApiKey'];
+                };
+            };
+            /** @description ACCESS_DENIED, PLAN_FEATURE_UNAVAILABLE, USAGE_QUOTA_EXCEEDED */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalAccessDeniedOrPlanFeatureUnavailableOrUsageQuotaExceeded'];
+                };
+            };
+            /** @description RESOURCE_NOT_FOUND */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalResourceNotFound'];
+                };
+            };
+            /** @description RATE_LIMIT_EXCEEDED */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalRateLimitExceeded'];
+                };
+            };
+            /** @description INTERNAL_ERROR */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalInternalError'];
+                };
+            };
+            /** @description SERVICE_INDETERMINATE */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalServiceIndeterminate'];
+                };
+            };
+        };
+    };
     executeAdhocQuery: {
         parameters: {
             query?: never;
@@ -5831,6 +5959,7 @@ declare function matchRoute(url: string | URL, options?: MatchRouteOptions): Rou
 /**
  * Configuration types for the RelyIO SDK
  */
+
 interface RelyIOConfig {
     /** API key for authentication */
     apiKey: string;

package/dist/{index-BzOFJJKS.d.ts → index-Dzo-upNS.d.ts}

@@ -1,6 +1,69 @@
-import { J as MergedRelyIOConfig, A as ApiPath, a as ApiMethod, K as PathParamsOf, t as ApiResponse, W as Wire, s as RequestConfig, B as BaseContent, d as WhereClause, f as SortOptions, g as ContentQueryResult, Q as QueryOptions, C as CreateInput, U as UpdateInput, S as SDKError, x as BaseValidationError, w as ValidationViolation, N as components, O as paths, R as RelyIOConfig } from './index-FDak5ofk.js';
+import { J as MergedRelyIOConfig, A as ApiPath, a as ApiMethod, K as PathParamsOf, t as ApiResponse, W as Wire, s as RequestConfig, B as BaseContent, d as WhereClause, f as SortOptions, g as ContentQueryResult, Q as QueryOptions, C as CreateInput, U as UpdateInput, S as SDKError, x as BaseValidationError, w as ValidationViolation, N as components, O as paths, R as RelyIOConfig } from './index-mXUx2H99.js';
 import { a as SchemaDefinition, b as SchemaContentTypeNames, h as SchemaAssetTypeNames, M as InferAssetType, c as SchemaSingletonNames, t as InferSingleton, g as SchemaSettingsGroupNames, E as InferSettingsGroup, e as SchemaQueryNames, f as SchemaLocaleCodes } from './define-schema-DzYXk4HL.js';
 import { J as InferContentType } from './define-content-type-CBfnTWSS.js';
+import { DevUnreadableReason } from './dev-handshake/index.js';
+
+/**
+ * Dev-mode detection for `relyio dev` sandboxes — the SDK's I/O shell over `../dev-handshake`.
+ *
+ * Every rule about the handshake — the path, the env names, the required fields, the deadline —
+ * lives in `@relyio/sdk/dev-handshake`, which `relyio dev` imports too. What is left here is the
+ * part that is genuinely the SDK's: reading env and walking the filesystem from the cwd, both of
+ * which have to happen without a static `node:*` import so the module stays browser-safe.
+ *
+ * Node access goes through `process.getBuiltinModule` (Node ≥ 20.16 / 22, and the platform targets
+ * Node 24), which is absent in browsers and edge runtimes — so the resolver is inert everywhere it
+ * should be, and a bundler never has to shim `fs`.
+ *
+ * **Order: env, then file.** The wrapped-child env is the primary carrier and wins. Before REL-647
+ * it won *unconditionally*, because it had no deadline to lose on; it now goes through the same
+ * rule the file does.
+ */
+
+/**
+ * What the handshake says about the sandbox, as the preview toolbar displays it
+ * (`sdk-surfaces-spec.md` decision 22). `TypedRelyIOClient.sandbox` returns it.
+ *
+ * **Plain data, on purpose.** In Next the toolbar is rendered from a server layout, and a client
+ * cannot cross the RSC boundary — while the browser cannot read the handshake at all, because this
+ * module is inert without `process.getBuiltinModule`. So the server-created client's `sandbox` is the
+ * prop the toolbar is handed, and it has to survive `JSON` unchanged: strings and `null`, dates as
+ * the ISO strings the handshake carried, no class instances.
+ *
+ * **No key.** The handshake also carries the sandbox's preview key; that is the client's credential,
+ * held beside this value in {@link DevResolution} and never inside it, so handing the state around
+ * does not hand the key with it.
+ *
+ * - `active` — the client targets the sandbox. `branchId` is `null` from the env carrier, which names
+ *   no branch; only `.relyio/dev.json` does. `expiresAt` is `null` for an unbounded sandbox.
+ * - `expired` / `unreadable` — a handshake was found and refused; the client targets the configured
+ *   dataset and key, and `mergeConfig` has said so on the console.
+ * - `absent` — no handshake on either carrier. This is also what a browser or edge runtime reads,
+ *   since neither can see the env or the file.
+ * - `disabled` — detection did not run: `dev: false` was passed, or `NODE_ENV === 'production'`
+ *   and `dev: true` was not.
+ */
+type SandboxState = {
+    state: 'active';
+    datasetId: string;
+    branchId: string | null;
+    expiresAt: string | null;
+    source: 'env' | 'file';
+} | {
+    state: 'expired';
+    expiredAt: string;
+} | {
+    state: 'unreadable';
+    reason: DevUnreadableReason;
+} | {
+    state: 'absent';
+} | {
+    state: 'disabled';
+};
+/** The sandbox the client targets, once a carrier has been accepted. */
+type ActiveSandbox = Extract<SandboxState, {
+    state: 'active';
+}>;
 
 /**
  * What a call site supplies beside the route it named.
@@ -2557,6 +2620,15 @@ type RegisteredSchema = Register extends {
     schema: infer S extends AnySchemaDefinition;
 } ? S : undefined;
 
+/**
+ * The key's project, as `GET /v1/project` describes it: organization, project, dataset and branch,
+ * each by id and name, and `studioUrl` — the Studio root the preview toolbar deep-links from
+ * (`sdk-surfaces-spec.md` decision 24), or `null` when the service has no Dashboard address.
+ *
+ * Read from the committed document's `application/json` content by name, never written here
+ * (`INV-API-CLIENT-IS-DERIVED`); `derived-transport.types.ts` holds the two equal.
+ */
+type Project = paths['/v1/project']['get']['responses'][200]['content']['application/json']['data'];
 /**
  * Client configuration with optional schema
  */
@@ -2592,6 +2664,7 @@ interface TypedClientConfig<TSchema extends AnySchemaDefinition | undefined = un
 declare class TypedRelyIOClient<TSchema extends AnySchemaDefinition | undefined = undefined> {
     private httpClient;
     private config;
+    private _sandbox;
     private _search;
     private _batch;
     private _adhocQuery;
@@ -2601,6 +2674,21 @@ declare class TypedRelyIOClient<TSchema extends AnySchemaDefinition | undefined
      * Get the schema definition
      */
     get schema(): TSchema;
+    /**
+     * The `relyio dev` sandbox this client resolved at construction, as the preview toolbar displays
+     * it (`sdk-surfaces-spec.md` decision 22).
+     *
+     * Plain, JSON-serializable data and no key, so a server component can hand it to a client
+     * component as a prop — the browser cannot read the handshake itself, so a client created there
+     * reports `absent`. See {@link SandboxState} for what each state means.
+     *
+     * @example
+     * ```tsx
+     * // app/layout.tsx — a server component handing the state to a client component
+     * <SandboxBadge sandbox={relyio.sandbox} />
+     * ```
+     */
+    get sandbox(): SandboxState;
     /**
      * Get the ad-hoc query client
      */
@@ -2779,6 +2867,21 @@ declare class TypedRelyIOClient<TSchema extends AnySchemaDefinition | undefined
      * ```
      */
     executeQuery<K extends TSchema extends AnySchemaDefinition ? SchemaQueryNames<TSchema> : string>(queryName: K, params?: Record<string, unknown>): Promise<unknown[]>;
+    /**
+     * Describe the project this key resolves to — `GET /v1/project`.
+     *
+     * `dataset` is the one this client's requests select (`dataset`, a sandbox from the `relyio dev`
+     * handshake, or the key's default), which is not always the project's default, so a Studio link
+     * built from `studioUrl` should carry it as `?dataset=`. `studioUrl` is `null` — a value, not an
+     * error — when the service has no Dashboard address configured.
+     *
+     * @example
+     * ```typescript
+     * const { studioUrl, dataset } = await relyio.project()
+     * if (studioUrl !== null) window.open(`${studioUrl}?dataset=${dataset.id}`)
+     * ```
+     */
+    project(): Promise<Project>;
     /**
      * Get schema information from the API
      */
@@ -2930,4 +3033,4 @@ declare function createClient<TSchema extends AnySchemaDefinition>(config: Typed
  */
 type ClientSchema<T extends TypedRelyIOClient<AnySchemaDefinition>> = T extends TypedRelyIOClient<infer TSchema> ? TSchema : never;
 
-export { type FullTextConfig as $, AutocompleteBuilder as A, type SimilarResult as B, type ClientSchema as C, type SimilarResponse as D, type ExtendedQueryResult as E, type SearchFilter as F, type SearchFields as G, HttpClient as H, BatchClient as I, BatchBuilder as J, type BatchMethod as K, type BatchOperation as L, type BatchOptions as M, type BatchOperationResult as N, type BatchSummary as O, type BatchResponse as P, AdhocQueryClient as Q, type Register as R, type SendOptions as S, TypedRelyIOClient as T, AdhocQueryBuilder as U, type FetchBlock as V, type AggregateBlock as W, type AggregateMetric as X, type SearchBlock as Y, type SimilarBlock as Z, type FilterValue as _, type TypedClientConfig as a, type AdhocQueryDefinition as a0, type AdhocQueryOptions as a1, type QueryMetadata as a2, type AdhocQueryResult as a3, AssetClient as a4, AssetFileBuilder as a5, AssetUploadBuilder as a6, isAssetEntry as a7, type AssetVisibility as a8, type FileStatus as a9, validateFile as aA, type FileBackend as aa, type AssetFileBlock as ab, type AssetFileExtracted as ac, type AssetUrls as ad, type AssetEntryResponse as ae, type PopulatedAssetReference as af, type PresignInput as ag, type PresignResult as ah, type ConfirmInput as ai, type ConfirmResult as aj, type ResolveUrlInput as ak, type ResolveUrlResult as al, type CreateAssetOptions as am, type WaitUntilReadyOptions as an, type MultipartCreateResult as ao, type MultipartPart as ap, type MultipartTarget as aq, type UploadProgress as ar, ResourceNotFoundError as as, ResourceConflictError as at, ResourceExpiredError as au, isResourceNotFound as av, type FileErrorCode as aw, FileUploadError as ax, FileValidationError as ay, type FileValidationConstraints as az, type RegisteredSchema as b, createClient as c, type ConditionalWriteOptions as d, entityTagOf as e, type RetryableWriteOptions as f, ChangesExpiredError as g, type Change as h, type ChangesOptions as i, type ChangesExpiredReason as j, ContentClient as k, SingletonClient as l, SettingsClient as m, ContentQueryBuilder as n, ContentByIdBuilder as o, type ChildrenOptions as p, type SingletonFetchOptions as q, type SettingsFetchOptions as r, SearchClient as s, SearchBuilder as t, SimilarBuilder as u, type SearchMode as v, type SearchResultItem as w, type SearchResponse as x, type AutocompleteSuggestion as y, type AutocompleteResponse as z };
+export { type SearchBlock as $, type ActiveSandbox as A, type AutocompleteSuggestion as B, type Change as C, type AutocompleteResponse as D, type ExtendedQueryResult as E, type SimilarResult as F, type SimilarResponse as G, HttpClient as H, type SearchFilter as I, type SearchFields as J, BatchClient as K, BatchBuilder as L, type BatchMethod as M, type BatchOperation as N, type BatchOptions as O, type Project as P, type BatchOperationResult as Q, type Register as R, type SandboxState as S, TypedRelyIOClient as T, type BatchSummary as U, type BatchResponse as V, AdhocQueryClient as W, AdhocQueryBuilder as X, type FetchBlock as Y, type AggregateBlock as Z, type AggregateMetric as _, type TypedClientConfig as a, type SimilarBlock as a0, type FilterValue as a1, type FullTextConfig as a2, type AdhocQueryDefinition as a3, type AdhocQueryOptions as a4, type QueryMetadata as a5, type AdhocQueryResult as a6, AssetClient as a7, AssetFileBuilder as a8, AssetUploadBuilder as a9, FileUploadError as aA, FileValidationError as aB, type FileValidationConstraints as aC, validateFile as aD, isAssetEntry as aa, type AssetVisibility as ab, type FileStatus as ac, type FileBackend as ad, type AssetFileBlock as ae, type AssetFileExtracted as af, type AssetUrls as ag, type AssetEntryResponse as ah, type PopulatedAssetReference as ai, type PresignInput as aj, type PresignResult as ak, type ConfirmInput as al, type ConfirmResult as am, type ResolveUrlInput as an, type ResolveUrlResult as ao, type CreateAssetOptions as ap, type WaitUntilReadyOptions as aq, type MultipartCreateResult as ar, type MultipartPart as as, type MultipartTarget as at, type UploadProgress as au, ResourceNotFoundError as av, ResourceConflictError as aw, ResourceExpiredError as ax, isResourceNotFound as ay, type FileErrorCode as az, type ClientSchema as b, createClient as c, type RegisteredSchema as d, type SendOptions as e, entityTagOf as f, type ConditionalWriteOptions as g, type RetryableWriteOptions as h, ChangesExpiredError as i, type ChangesOptions as j, type ChangesExpiredReason as k, ContentClient as l, SingletonClient as m, SettingsClient as n, ContentQueryBuilder as o, ContentByIdBuilder as p, type ChildrenOptions as q, type SingletonFetchOptions as r, type SettingsFetchOptions as s, SearchClient as t, SearchBuilder as u, AutocompleteBuilder as v, SimilarBuilder as w, type SearchMode as x, type SearchResultItem as y, type SearchResponse as z };

package/dist/{index-FDak5ofk.d.ts → index-mXUx2H99.d.ts}

@@ -574,6 +574,26 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    '/v1/project': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Describe the key's project
+         * @description The organization, project, dataset and branch this key resolves to, each with its id and name, and `studioUrl` — the Studio root for the project, built from ids. `dataset` is the one this request selected (`X-RelyIO-Dataset`, or the key’s default), which is not always the project’s default: a Studio link should carry it as `?dataset=`. `studioUrl` is `null` when the service has no Dashboard address configured. Never cached.
+         */
+        get: operations['getProject'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/v1/query': {
         parameters: {
             query?: never;
@@ -863,6 +883,28 @@ interface components {
             limit: number;
             total: number;
         };
+        /** @description The place this key resolves to, named, and the Studio root for its project. `id` and `name` are the project’s. */
+        Project: {
+            id: string;
+            name: string;
+            /** @description The organization that owns the project. */
+            organization: {
+                id: string;
+                name: string;
+            };
+            /** @description The dataset this request was answered from — the one `X-RelyIO-Dataset` selected, or the key’s default. */
+            dataset: {
+                id: string;
+                name: string;
+            };
+            /** @description The branch that dataset is assigned to. */
+            branch: {
+                id: string;
+                name: string;
+            };
+            /** @description `<dashboard>/o/<organization id>/<project id>/studio`, or null when the service has no Dashboard address configured. */
+            studioUrl: string | null;
+        };
         RefusalAccessDenied: {
             error: {
                 /** @enum {string} */
@@ -4227,6 +4269,92 @@ interface operations {
             };
         };
     };
+    getProject: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Success. */
+            200: {
+                headers: {
+                    'Cache-Control'?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': {
+                        data: components['schemas']['Project'];
+                    };
+                };
+            };
+            /** @description REQUEST_INVALID */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalRequestInvalid'];
+                };
+            };
+            /** @description INVALID_API_KEY, MISSING_API_KEY */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalInvalidApiKeyOrMissingApiKey'];
+                };
+            };
+            /** @description ACCESS_DENIED, PLAN_FEATURE_UNAVAILABLE, USAGE_QUOTA_EXCEEDED */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalAccessDeniedOrPlanFeatureUnavailableOrUsageQuotaExceeded'];
+                };
+            };
+            /** @description RESOURCE_NOT_FOUND */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalResourceNotFound'];
+                };
+            };
+            /** @description RATE_LIMIT_EXCEEDED */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalRateLimitExceeded'];
+                };
+            };
+            /** @description INTERNAL_ERROR */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalInternalError'];
+                };
+            };
+            /** @description SERVICE_INDETERMINATE */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['RefusalServiceIndeterminate'];
+                };
+            };
+        };
+    };
     executeAdhocQuery: {
         parameters: {
             query?: never;
@@ -5831,6 +5959,7 @@ declare function matchRoute(url: string | URL, options?: MatchRouteOptions): Rou
 /**
  * Configuration types for the RelyIO SDK
  */
+
 interface RelyIOConfig {
     /** API key for authentication */
     apiKey: string;