@relyio/sdk 0.4.0 → 0.6.0

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

@@ -1,4 +1,4 @@
-import { H as EntryMetadata } from './define-content-type-CBfnTWSS.js';
+import { P as EntryMetadata } from './define-content-type-CDB3kyeA.js';
 
 /**
  * Generated by scripts/emit-openapi-types.mjs from @relyio/api's committed
@@ -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;
@@ -835,7 +855,7 @@ interface components {
         ErrorResponse: {
             error: {
                 /** @enum {string} */
-                code: 'ACCESS_DENIED' | 'CONTENT_INVALID' | 'INTERNAL_ERROR' | 'INVALID_API_KEY' | 'METHOD_NOT_ALLOWED' | 'MISSING_API_KEY' | 'PAYLOAD_TOO_LARGE' | 'PLAN_DOWNGRADE_BLOCKED' | 'PLAN_FEATURE_UNAVAILABLE' | 'RATE_LIMIT_EXCEEDED' | 'READ_ONLY_KEY' | 'REQUEST_INVALID' | 'REQUEST_TIMEOUT' | 'RESOURCE_CONFLICT' | 'RESOURCE_EXPIRED' | 'RESOURCE_NOT_FOUND' | 'REVERIFICATION_REQUIRED' | 'SERVICE_INDETERMINATE' | 'TRANSACTION_ROLLED_BACK' | 'USAGE_QUOTA_EXCEEDED';
+                code: 'ACCESS_DENIED' | 'CONTENT_INVALID' | 'INTERNAL_ERROR' | 'INVALID_API_KEY' | 'METHOD_NOT_ALLOWED' | 'MISSING_API_KEY' | 'ORGANIZATION_DELETE_BLOCKED' | 'PAYLOAD_TOO_LARGE' | 'PLAN_DOWNGRADE_BLOCKED' | 'PLAN_FEATURE_UNAVAILABLE' | 'RATE_LIMIT_EXCEEDED' | 'READ_ONLY_KEY' | 'REQUEST_INVALID' | 'REQUEST_TIMEOUT' | 'RESOURCE_CONFLICT' | 'RESOURCE_EXPIRED' | 'RESOURCE_NOT_FOUND' | 'REVERIFICATION_REQUIRED' | 'SERVICE_INDETERMINATE' | 'TRANSACTION_ROLLED_BACK' | 'USAGE_QUOTA_EXCEEDED';
                 messages: string[];
                 details?: {
                     [key: string]: unknown;
@@ -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} */
@@ -998,7 +1040,7 @@ interface components {
             id?: string;
             error: {
                 /** @enum {string} */
-                code: 'ACCESS_DENIED' | 'CONTENT_INVALID' | 'INTERNAL_ERROR' | 'INVALID_API_KEY' | 'METHOD_NOT_ALLOWED' | 'MISSING_API_KEY' | 'PAYLOAD_TOO_LARGE' | 'PLAN_DOWNGRADE_BLOCKED' | 'PLAN_FEATURE_UNAVAILABLE' | 'RATE_LIMIT_EXCEEDED' | 'READ_ONLY_KEY' | 'REQUEST_INVALID' | 'REQUEST_TIMEOUT' | 'RESOURCE_CONFLICT' | 'RESOURCE_EXPIRED' | 'RESOURCE_NOT_FOUND' | 'REVERIFICATION_REQUIRED' | 'SERVICE_INDETERMINATE' | 'TRANSACTION_ROLLED_BACK' | 'USAGE_QUOTA_EXCEEDED';
+                code: 'ACCESS_DENIED' | 'CONTENT_INVALID' | 'INTERNAL_ERROR' | 'INVALID_API_KEY' | 'METHOD_NOT_ALLOWED' | 'MISSING_API_KEY' | 'ORGANIZATION_DELETE_BLOCKED' | 'PAYLOAD_TOO_LARGE' | 'PLAN_DOWNGRADE_BLOCKED' | 'PLAN_FEATURE_UNAVAILABLE' | 'RATE_LIMIT_EXCEEDED' | 'READ_ONLY_KEY' | 'REQUEST_INVALID' | 'REQUEST_TIMEOUT' | 'RESOURCE_CONFLICT' | 'RESOURCE_EXPIRED' | 'RESOURCE_NOT_FOUND' | 'REVERIFICATION_REQUIRED' | 'SERVICE_INDETERMINATE' | 'TRANSACTION_ROLLED_BACK' | 'USAGE_QUOTA_EXCEEDED';
                 messages: string[];
                 details?: {
                     [key: string]: unknown;
@@ -1530,7 +1572,6 @@ interface operations {
                     ETag?: string;
                     Vary?: string;
                     'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -1732,7 +1773,6 @@ interface operations {
                     ETag?: string;
                     Vary?: string;
                     'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     'X-Entity-Tag'?: string;
                     [name: string]: unknown;
                 };
@@ -2042,7 +2082,6 @@ interface operations {
                     ETag?: string;
                     Vary?: string;
                     'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -3715,8 +3754,6 @@ interface operations {
                 headers: {
                     'Cache-Control'?: string;
                     Vary?: string;
-                    'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -3796,8 +3833,6 @@ interface operations {
                 headers: {
                     'Cache-Control'?: string;
                     Vary?: string;
-                    'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -3886,8 +3921,6 @@ interface operations {
                 headers: {
                     'Cache-Control'?: string;
                     Vary?: string;
-                    'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -3967,8 +4000,6 @@ interface operations {
                 headers: {
                     'Cache-Control'?: string;
                     Vary?: string;
-                    'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -4059,8 +4090,6 @@ interface operations {
                 headers: {
                     'Cache-Control'?: string;
                     Vary?: string;
-                    'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -4151,8 +4180,6 @@ interface operations {
                 headers: {
                     'Cache-Control'?: string;
                     Vary?: string;
-                    'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -4227,6 +4254,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;
@@ -4239,6 +4352,8 @@ interface operations {
             /** @description Success. */
             200: {
                 headers: {
+                    'Cache-Control'?: string;
+                    'X-Cache'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -4334,6 +4449,8 @@ interface operations {
             /** @description Success. */
             200: {
                 headers: {
+                    'Cache-Control'?: string;
+                    'X-Cache'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -4423,6 +4540,8 @@ interface operations {
             /** @description Success. */
             200: {
                 headers: {
+                    'Cache-Control'?: string;
+                    'X-Cache'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -4503,6 +4622,8 @@ interface operations {
             /** @description Success. */
             200: {
                 headers: {
+                    'Cache-Control'?: string;
+                    'X-Cache'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -4596,7 +4717,6 @@ interface operations {
                     ETag?: string;
                     Vary?: string;
                     'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     [name: string]: unknown;
                 };
                 content: {
@@ -4680,7 +4800,6 @@ interface operations {
                     ETag?: string;
                     Vary?: string;
                     'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     'X-Entity-Tag'?: string;
                     [name: string]: unknown;
                 };
@@ -5257,7 +5376,6 @@ interface operations {
                     ETag?: string;
                     Vary?: string;
                     'X-Cache'?: string;
-                    'X-Cache-Key'?: string;
                     'X-Entity-Tag'?: string;
                     [name: string]: unknown;
                 };
@@ -5831,8 +5949,16 @@ declare function matchRoute(url: string | URL, options?: MatchRouteOptions): Rou
 /**
  * Configuration types for the RelyIO SDK
  */
+
 interface RelyIOConfig {
-    /** API key for authentication */
+    /**
+     * API key for authentication, sent as `X-API-Key`.
+     *
+     * Required by every request, not by construction: a client built without one — a module-scope
+     * client whose `process.env` variable is unset during a build — constructs, and each request it
+     * makes rejects with `MissingApiKeyError` before anything is sent. Under `relyio dev` the
+     * sandbox's key is used instead, so none need be configured.
+     */
     apiKey: string;
     /** Base URL for the RelyIO API */
     baseUrl?: string;
@@ -6013,7 +6139,19 @@ interface ApiResponse<T = unknown> {
     };
 }
 interface BrowserConfig {
-    /** Whether to include credentials in CORS requests (defaults to true) */
+    /**
+     * Whether requests the client sends from a web page carry the browser's cookies to another
+     * origin (defaults to `true`).
+     *
+     * `true` sends every request with `credentials: 'include'`. `false` sends it with
+     * `credentials: 'same-origin'`: nothing to another origin, and a same-origin request — the API
+     * behind a proxy on your own host — sent as the platform's own `fetch` would send it. The RelyIO
+     * API authenticates with your API key and reads no cookie, so `false` changes nothing it
+     * answers.
+     *
+     * Applied only where `window` exists. On a server, in an edge runtime or in a Web Worker the
+     * client sets no `credentials` mode at all, whatever this says.
+     */
     includeCredentials?: boolean;
     /** Whether to use relative URLs for same-origin requests (defaults to false) */
     useRelativeUrls?: boolean;
@@ -6092,7 +6230,12 @@ interface ValidationViolation {
 declare abstract class BaseValidationError extends SDKError {
     readonly retryable = false;
     readonly violations: ValidationViolation[];
-    constructor(message?: string, violations?: ValidationViolation[], statusCode?: number, cause?: Error);
+    /**
+     * @param context - Carried beside `violations`. The mapper passes the refusal body as
+     *   `context.response`, as it does for every other contract code, so a consumer that hands the
+     *   service's own words on can read them here too.
+     */
+    constructor(message?: string, violations?: ValidationViolation[], statusCode?: number, cause?: Error, context?: Record<string, unknown>);
     getUserMessage(): string;
     /**
      * Get violations for a specific field
@@ -6112,7 +6255,7 @@ declare class ValidationError extends BaseValidationError {
 }
 declare class InvalidPayloadError extends BaseValidationError {
     readonly code = "INVALID_PAYLOAD";
-    constructor(message?: string, violations?: ValidationViolation[], cause?: Error);
+    constructor(message?: string, violations?: ValidationViolation[], cause?: Error, context?: Record<string, unknown>);
     getUserMessage(): string;
 }
 declare class SchemaValidationError extends BaseValidationError {
@@ -6156,13 +6299,32 @@ interface BaseContent {
         sourceDatasetId?: string;
     };
 }
+/**
+ * The value a `where` condition compares a field against: one of the values the field holds.
+ *
+ * Not the field's read type. The REST dialect (`fromRestWhere` in `@relyio/entry-reads`) reads a
+ * bare value as `eq`, an array as `in` and an object as operators — refusing an object with none —
+ * and drops `null`. So a list field (`tags`) is matched by one of its items, a reference by the
+ * target's id, and a component or an expanded entry is never a value to send.
+ */
+type WhereScalar<V> = Exclude<V extends readonly (infer Item)[] ? Item : V, null | undefined | object>;
+/** One field's condition: a value (`eq`), a list of values (`in`), or operators. */
+type WhereFieldCondition<V> = WhereScalar<V> | WhereScalar<V>[] | WhereOperator<WhereScalar<V>>;
 /**
  * Query conditions for filtering content
  * Supports both content fields and metadata fields
+ *
+ * Typed by the content type's fields where a schema types the client: each key is a declared field
+ * and each value one of that field's values. Untyped (`BaseContent`, which declares no fields), any
+ * field name is accepted — nothing declares which exist.
  */
-type WhereClause<T extends BaseContent = BaseContent> = {
-    [K in keyof Omit<T, '_metadata'>]?: T[K] | WhereOperator<T[K]>;
-} & {
+type WhereClause<T extends BaseContent = BaseContent> = ([
+    Exclude<keyof T, '_metadata'>
+] extends [never] ? {
+    [field: string]: unknown;
+} : {
+    [K in Exclude<keyof T, '_metadata'>]?: WhereFieldCondition<T[K]>;
+}) & {
     /** Metadata field conditions */
     _metadata?: {
         [K in keyof T['_metadata']]?: T['_metadata'][K] | WhereOperator<T['_metadata'][K]>;
@@ -6441,4 +6603,4 @@ interface PerformanceMetrics {
     cacheHitRatio?: number;
 }
 
-export { type ApiPath as A, type BaseContent as B, type CreateInput as C, type DebugConfig as D, type Environment as E, type FieldTypeName as F, RequiredFieldError as G, InvalidFieldTypeError as H, InvalidPayloadError as I, type MergedRelyIOConfig as J, type PathParamsOf as K, type LogLevel as L, type MatchRouteOptions as M, type components as N, type paths as O, type PerformanceMetrics as P, type QueryOptions as Q, type RelyIOConfig as R, SDKError as S, type FieldDefinition as T, type UpdateInput as U, type ValidationRule as V, type Wire as W, type ApiMethod as a, type ApiSuccessBody as b, type RouteMatch as c, type WhereClause as d, type WhereOperator as e, type SortOptions as f, type ContentQueryResult as g, type SingletonContent as h, type SettingsGroup as i, type CustomQuery as j, type ContentTypeSchema as k, type FieldOptions as l, matchRoute as m, type RealtimeEventType as n, type RealtimeEvent as o, type SubscriptionOptions as p, type CacheConfig as q, type RealtimeConfig as r, type RequestConfig as s, type ApiResponse as t, type RetryConfig as u, type CacheStrategy as v, type ValidationViolation as w, BaseValidationError as x, ValidationError as y, SchemaValidationError as z };
+export { type ApiPath as A, type BaseContent as B, type CreateInput as C, type DebugConfig as D, type Environment as E, type FieldTypeName as F, ValidationError as G, SchemaValidationError as H, InvalidPayloadError as I, RequiredFieldError as J, InvalidFieldTypeError as K, type LogLevel as L, type MatchRouteOptions as M, type MergedRelyIOConfig as N, type PathParamsOf as O, type PerformanceMetrics as P, type QueryOptions as Q, type RelyIOConfig as R, SDKError as S, type components as T, type UpdateInput as U, type ValidationRule as V, type Wire as W, type paths as X, type FieldDefinition as Y, type ApiMethod as a, type ApiSuccessBody as b, type RouteMatch as c, type WhereScalar as d, type WhereFieldCondition as e, type WhereClause as f, type WhereOperator as g, type SortOptions as h, type ContentQueryResult as i, type SingletonContent as j, type SettingsGroup as k, type CustomQuery as l, matchRoute as m, type ContentTypeSchema as n, type FieldOptions as o, type RealtimeEventType as p, type RealtimeEvent as q, type SubscriptionOptions as r, type CacheConfig as s, type RealtimeConfig as t, type RequestConfig as u, type ApiResponse as v, type RetryConfig as w, type CacheStrategy as x, type ValidationViolation as y, BaseValidationError as z };