@relyio/sdk 0.18.0 → 0.19.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/CHANGELOG.md +20 -0
- package/dist/automations/index.cjs +18 -17
- package/dist/automations/index.d.cts +289 -8
- package/dist/automations/index.d.ts +289 -8
- package/dist/automations/index.js +3 -2
- package/dist/{chunk-ZHTJ7GXH.js → chunk-356SF5Y2.js} +84 -26
- package/dist/{chunk-ZAMAR3X2.cjs → chunk-5F3YYPLZ.cjs} +11249 -10771
- package/dist/{chunk-LSI26ZN2.cjs → chunk-DBYMG6MQ.cjs} +5 -5
- package/dist/{chunk-SHSK7UUY.cjs → chunk-NN45CSPZ.cjs} +177 -11
- package/dist/{chunk-IFKF72VJ.cjs → chunk-P23G5NXD.cjs} +122 -63
- package/dist/{chunk-W7JFHSFM.js → chunk-PZCDJFMA.js} +11249 -10772
- package/dist/{chunk-EDE2H37D.js → chunk-T7LGREB3.js} +174 -12
- package/dist/{chunk-R6E4HE7R.js → chunk-W2GRVXDG.js} +3 -3
- package/dist/client/index.cjs +4 -4
- package/dist/client/index.d.cts +4 -4
- package/dist/client/index.d.ts +4 -4
- package/dist/client/index.js +2 -2
- package/dist/{define-content-type-NEQDrvdq.d.cts → define-content-type-BZ6X8GvL.d.cts} +1324 -156
- package/dist/{define-content-type-fb-WCD5e.d.ts → define-content-type-C12jh8cY.d.ts} +1324 -156
- package/dist/{define-schema-Dlwh6l_J.d.ts → define-schema-BPlZl4a2.d.cts} +104 -3
- package/dist/{define-schema-DZhtvLiK.d.cts → define-schema-CK7TtYot.d.ts} +104 -3
- package/dist/extensions/index.cjs +26 -6
- package/dist/extensions/index.d.cts +5 -791
- package/dist/extensions/index.d.ts +5 -791
- package/dist/extensions/index.js +24 -4
- package/dist/functions/index.cjs +7 -4
- package/dist/functions/index.d.cts +4 -4
- package/dist/functions/index.d.ts +4 -4
- package/dist/functions/index.js +5 -2
- package/dist/{index-M3luH06A.d.ts → index-BxNnlc5D.d.ts} +91 -73
- package/dist/{index-C4LqrNd1.d.ts → index-C-MymZTe.d.ts} +1 -1
- package/dist/{index-DwHcL6x5.d.cts → index-D5jyIeQ5.d.cts} +91 -73
- package/dist/{index-Dnmt_UOo.d.cts → index-DN0l8RHw.d.cts} +1 -1
- package/dist/index.cjs +88 -84
- package/dist/index.d.cts +64 -14
- package/dist/index.d.ts +64 -14
- package/dist/index.js +4 -4
- package/dist/preview/index.cjs +3 -3
- package/dist/preview/index.js +1 -1
- package/dist/{register-B53i97A9.d.ts → register-BiMQKVp-.d.ts} +24 -8
- package/dist/{register-BYCs0FpF.d.cts → register-DeMsaurp.d.cts} +24 -8
- package/dist/rich-text/index.d.cts +2 -2
- package/dist/rich-text/index.d.ts +2 -2
- package/dist/schema/index.cjs +41 -40
- package/dist/schema/index.d.cts +7 -120
- package/dist/schema/index.d.ts +7 -120
- package/dist/schema/index.js +2 -1
- package/dist/types/index.d.cts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import { C as Change, a as ChangesExpiredError, V as VisitorRetry, b as ChangesExpiredReason } from './index-
|
|
2
|
-
export { A as ActiveSandbox, aC as AdhocQuery, aD as AdhocRecord, aA as AggregateMetric, aL as AssetClient, aU as AssetEntryResponse, aM as AssetFileBuilder, aS as AssetFileExtracted, aV as AssetFileWhere, b2 as AssetPlacement, aN as AssetUploadBuilder, aP as AssetVisibility, ac as AutocompleteOptions, a7 as AutocompleteResponse, a6 as AutocompleteSuggestion, as as BatchBody, at as BatchCreate, aw as BatchDelete, az as BatchDeleteTarget, an as BatchOperationResult, av as BatchReplace, ap as BatchResponse, ax as BatchSingletonWrite, ao as BatchSummary, ay as BatchTarget, au as BatchUpdate, aq as BatchWrite, ar as BatchWriteOptions, j as ChangesHeadOptions, k as ChangesOptions, W as ChildEntry, B as ChildrenListOptions, z as ChildrenOptions, X as ChildrenRead, e as ClientDefaults, f as ClientSchema, aZ as ConfirmInput, a_ as ConfirmResult, o as ContentClient, b1 as CreateAssetOptions, p as CreateEntryOptions, g as DeployedContentType, D as DeployedLocale, t as DocumentFields, G as DocumentReadOptions, u as DocumentVersion, w as DocumentVersionRow, x as DocumentVersionsOptions, y as DocumentWriteOptions, I as EntryList, E as EntryPlacement, q as EntryWriteOptions, F as FeedChange, J as FieldKey, aR as FileBackend, be as FileErrorCode, aQ as FileStatus, aT as FileStatusResult, bg as FileUploadError, bf as FileUploadErrorCode, bi as FileValidationConstraints, bh as FileValidationError, K as FreshOption, M as GetOptions, H as Health, l as LIVE_KEEPALIVE_INTERVAL_MS, m as LIVE_SOCKET_OPEN_TIMEOUT_MS, N as ListAllOptions, O as ListOptions, n as LiveChangesOptions, L as LocaleCodeOf, Q as LocaleOption, b5 as MultipartCreateResult, b6 as MultipartPart, b7 as MultipartTarget, aE as NamedQueryOptions, aF as NamedQueryParams, U as Paging, aW as PopulatedAssetReference, aX as PresignInput, aY as PresignResult, P as Project, aG as QueryAggregate, aH as QueryAnswer, aI as QueryCall, aB as QueryMetadata, aJ as QueryName, aK as QueryTypeName, Y as ReadAs, h as ReadEntry, _ as ReadLocale, R as RecordsAccessor, a$ as ResolveUrlInput, b0 as ResolveUrlResult, ba as ResourceConflictError, bb as ResourceExpiredError, b9 as ResourceNotFoundError, i as RetryableWriteOptions, S as SandboxState, ab as SearchEntry, ad as SearchFacet, ae as SearchFieldKey, af as SearchHighlight, a4 as SearchHitMetadata, ag as SearchOptions, ah as SearchPage, a5 as SearchResponse, a3 as SearchResultItem, ai as SearchScope, aj as SearchSelected, ak as SearchSortOption, aa as SearchTypeName, al as SearchWhere, s as SettingsClient, am as SimilarOptions, a9 as SimilarResponse, a8 as SimilarResult, r as SingletonClient, $ as SortOption, d as TypedClientConfig, T as TypedRelyIOClient, b3 as UpdateAssetOptions, b8 as UploadProgress, a0 as VersionOptions, b4 as WaitUntilReadyOptions, Z as WithChildren, a1 as WrittenReadScope, a2 as WrittenSort, c as createClient, c as default, aO as isAssetEntry, bd as isMissingEntry, bc as isResourceNotFound, bj as validateFile, v as versionCheckOf } from './index-
|
|
3
|
-
export { A as AnySchemaDefinition, f as ApiMethod, e as ApiPath, g as ApiSuccessBody, B as BaseRecord, D as DefaultRetryPolicy, H as HttpClient, M as MatchRouteOptions, y as RecordBatchOperation, z as RecordBatchOperationResult, C as RecordBatchOptions, b as RecordBatchResult, a as RecordBatchTarget, n as RecordCallOptions,
|
|
1
|
+
import { C as Change, a as ChangesExpiredError, V as VisitorRetry, b as ChangesExpiredReason } from './index-BxNnlc5D.js';
|
|
2
|
+
export { A as ActiveSandbox, aC as AdhocQuery, aD as AdhocRecord, aA as AggregateMetric, aL as AssetClient, aU as AssetEntryResponse, aM as AssetFileBuilder, aS as AssetFileExtracted, aV as AssetFileWhere, b2 as AssetPlacement, aN as AssetUploadBuilder, aP as AssetVisibility, ac as AutocompleteOptions, a7 as AutocompleteResponse, a6 as AutocompleteSuggestion, as as BatchBody, at as BatchCreate, aw as BatchDelete, az as BatchDeleteTarget, an as BatchOperationResult, av as BatchReplace, ap as BatchResponse, ax as BatchSingletonWrite, ao as BatchSummary, ay as BatchTarget, au as BatchUpdate, aq as BatchWrite, ar as BatchWriteOptions, j as ChangesHeadOptions, k as ChangesOptions, W as ChildEntry, B as ChildrenListOptions, z as ChildrenOptions, X as ChildrenRead, e as ClientDefaults, f as ClientSchema, aZ as ConfirmInput, a_ as ConfirmResult, o as ContentClient, b1 as CreateAssetOptions, p as CreateEntryOptions, g as DeployedContentType, D as DeployedLocale, t as DocumentFields, G as DocumentReadOptions, u as DocumentVersion, w as DocumentVersionRow, x as DocumentVersionsOptions, y as DocumentWriteOptions, I as EntryList, E as EntryPlacement, q as EntryWriteOptions, F as FeedChange, J as FieldKey, aR as FileBackend, be as FileErrorCode, aQ as FileStatus, aT as FileStatusResult, bg as FileUploadError, bf as FileUploadErrorCode, bi as FileValidationConstraints, bh as FileValidationError, K as FreshOption, M as GetOptions, H as Health, l as LIVE_KEEPALIVE_INTERVAL_MS, m as LIVE_SOCKET_OPEN_TIMEOUT_MS, N as ListAllOptions, O as ListOptions, n as LiveChangesOptions, L as LocaleCodeOf, Q as LocaleOption, b5 as MultipartCreateResult, b6 as MultipartPart, b7 as MultipartTarget, aE as NamedQueryOptions, aF as NamedQueryParams, U as Paging, aW as PopulatedAssetReference, aX as PresignInput, aY as PresignResult, P as Project, aG as QueryAggregate, aH as QueryAnswer, aI as QueryCall, aB as QueryMetadata, aJ as QueryName, aK as QueryTypeName, Y as ReadAs, h as ReadEntry, _ as ReadLocale, R as RecordsAccessor, a$ as ResolveUrlInput, b0 as ResolveUrlResult, ba as ResourceConflictError, bb as ResourceExpiredError, b9 as ResourceNotFoundError, i as RetryableWriteOptions, S as SandboxState, ab as SearchEntry, ad as SearchFacet, ae as SearchFieldKey, af as SearchHighlight, a4 as SearchHitMetadata, ag as SearchOptions, ah as SearchPage, a5 as SearchResponse, a3 as SearchResultItem, ai as SearchScope, aj as SearchSelected, ak as SearchSortOption, aa as SearchTypeName, al as SearchWhere, s as SettingsClient, am as SimilarOptions, a9 as SimilarResponse, a8 as SimilarResult, r as SingletonClient, $ as SortOption, d as TypedClientConfig, T as TypedRelyIOClient, b3 as UpdateAssetOptions, b8 as UploadProgress, a0 as VersionOptions, b4 as WaitUntilReadyOptions, Z as WithChildren, a1 as WrittenReadScope, a2 as WrittenSort, c as createClient, c as default, aO as isAssetEntry, bd as isMissingEntry, bc as isResourceNotFound, bj as validateFile, v as versionCheckOf } from './index-BxNnlc5D.js';
|
|
3
|
+
export { A as AnySchemaDefinition, f as ApiMethod, e as ApiPath, g as ApiSuccessBody, B as BaseRecord, D as DefaultRetryPolicy, H as HttpClient, M as MatchRouteOptions, y as RecordBatchOperation, z as RecordBatchOperationResult, C as RecordBatchOptions, b as RecordBatchResult, a as RecordBatchTarget, n as RecordCallOptions, d as RecordConditionValue, o as RecordFacetBucket, p as RecordFileBytes, q as RecordFileUploadOptions, s as RecordList, t as RecordListOptions, u as RecordMetadata, v as RecordReadOptions, w as RecordUpdateOptions, l as RecordsClient, c as Register, R as RegisteredSchema, j as RetryPolicy, k as RetryableRequest, h as RouteMatch, S as SendOptions, W as Wire, i as isReplaySafe, m as matchRoute, x as refusedOperationOf, r as retryPolicyFor } from './register-BiMQKVp-.js';
|
|
4
4
|
export { fields } from './schema/index.js';
|
|
5
|
-
import {
|
|
6
|
-
export {
|
|
7
|
-
export {
|
|
5
|
+
import { d3 as SDKError, aW as EntryMetadata } from './define-content-type-C12jh8cY.js';
|
|
6
|
+
export { aQ as AnyDeclaredFieldset, d2 as ApiResponse, d8 as AssetFileBlock, at as AssetReading, bc as AssetServedBlocks, b9 as AssetTypeDefinition, d9 as AssetUrls, da as BaseContent, B as BaseFieldConfig, dc as BaseSettingsGroup, db as BaseSingleton, dI as BaseValidationError, ar as BlockOf, dB as CacheConfig, dE as CacheStrategy, av as CheckInclude, au as CheckedIncludes, aw as ContentReading, aV as ContentTypeDefinition, du as ContentTypeSchema, dp as ContentVersion, dq as ContentVersionRow, di as CreateInput, dj as CreatedContent, dt as CustomQuery, dh as DateOnlyOperator, dC as DebugConfig, aP as DeclaredFieldset, dG as Environment, i as FieldDefinition, aS as FieldMember, dw as FieldOptions, j as FieldRule, al as FieldSchemaContext, k as FieldType, l as FieldUIConfig, am as FieldValue, an as FieldValues, aO as Fieldset, bf as FileKindConfig, bt as FileScanConfig, cx as FileUpload, bs as FileUploadConfig, bl as ImageExifConfig, bd as ImageKindConfig, bk as ImageSourceConfig, bj as ImageUploadConfig, ax as IncludablePaths, bb as InferAssetEntry, ba as InferAssetType, aX as InferContentType, ct as InferJsonSchema, b1 as InferSingleton, dK as InvalidPayloadError, cu as JsonFieldValue, cv as JsonSchema, cw as JsonValue, aq as Keyed, b8 as KeyedAssetTypeConfig, aT as KeyedContentTypeConfig, K as KeyedEnumConfig, n as KeyedField, o as KeyedFieldOptions, aR as KeyedFieldsetConfig, b3 as KeyedSettingsGroupConfig, a_ as KeyedSingletonConfig, d6 as LiveWebSocket, d7 as LiveWebSocketConstructor, aY as LocalePublicationFields, t as LocalizationConfig, u as Localized, v as LocalizedDetails, dF as LogLevel, N as NeverUniqueFieldConfig, dA as PerformanceMetrics, az as ReadWith, ay as Reading, dy as RealtimeEvent, dx as RealtimeEventType, cy as RecordFile, d4 as RelyIOConfig, d5 as RelyIOConfigUpdate, dD as RequestConfig, dn as RestoredContent, d0 as RetryConfig, dk as RevisedContent, b4 as SettingsGroupDefinition, aA as SettingsReading, as as ShapeValue, ds as SingletonContent, a$ as SingletonContentTypeDefinition, b0 as SingletonMetadata, aB as SingletonReading, dz as SubscriptionOptions, ap as UnresolvedEntry, aC as UntypedReading, dr as UpdateInput, dJ as ValidationError, dv as ValidationRule, dH as ValidationViolation, bm as VariantDefinition, bp as VideoCaptionsConfig, bq as VideoDownloadConfig, be as VideoKindConfig, bo as VideoPosterConfig, bn as VideoUploadConfig, br as VideoWatermarkConfig, df as WhereClause, de as WhereFieldCondition, dg as WhereOperator, dd as WhereScalar, Z as WidgetOptions, dm as WrittenSettingsGroup, dl as WrittenSingleton, b7 as defineAssetType, aM as defineContentType, aD as defineLocale, b2 as defineSettingsGroup, aZ as defineSingleton, aN as fieldset } from './define-content-type-C12jh8cY.js';
|
|
7
|
+
export { y as AggregateBlock, a6 as AnyQueryParameters, a7 as DeclaredParameters, x as FetchBlock, U as FilterDefinition, L as IncludeDefinition, a4 as InferQueryParams, a3 as InferQueryResponse, I as InferRecordType, Q as QueryConfig, u as QueryDefinition, a5 as QueryParameterValue, o as RecordFieldsOf, q as RecordUpdateFieldsOf, r as RecordWriteFieldsOf, h as SchemaAssetTypeNames, S as SchemaConfig, b as SchemaContentTypeNames, a as SchemaDefinition, j as SchemaEntry, k as SchemaEntryOf, f as SchemaLocaleCodes, e as SchemaQueryNames, g as SchemaSettingsGroupNames, c as SchemaSingletonNames, z as SearchBlock, T as SelectMapping, G as SortCondition, B as WhereCondition, t as defineQuery, d as defineSchema } from './define-schema-CK7TtYot.js';
|
|
8
8
|
export { camelToSnake, createDeferred, debounce, deepClone, generateId, isBrowser, isNode, isPlainObject, isValidEmail, isValidUrl, mergeDeep, omit, pick, retry, sleep, snakeToCamel, throttle, toSafeString } from './utils/index.js';
|
|
9
|
-
export { n as RICH_TEXT_VOID_TAGS, R as RelyIOFieldAttributes, a as RelyIOFieldName, b as RelyIOFieldPath, c as RelyIOKeyed, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, r as relyioField, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from './index-
|
|
9
|
+
export { n as RICH_TEXT_VOID_TAGS, R as RelyIOFieldAttributes, a as RelyIOFieldName, b as RelyIOFieldPath, c as RelyIOKeyed, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, r as relyioField, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from './index-C-MymZTe.js';
|
|
10
10
|
export { e as RichTextBlock, f as RichTextCellAlignment, g as RichTextCodeBlock, h as RichTextCodeGroup, i as RichTextCodeLines, j as RichTextDivider, d as RichTextEntryLinkMark, k as RichTextHeading, l as RichTextInline, m as RichTextLineBreak, n as RichTextLinkMark, o as RichTextList, p as RichTextListItem, q as RichTextListStyle, r as RichTextMark, s as RichTextMarkType, t as RichTextNode, u as RichTextParagraph, v as RichTextQuote, w as RichTextSpan, x as RichTextStructure, y as RichTextTable, z as RichTextTableCell, B as RichTextTableRow, b as RichTextValue } from './rich-text.d-BWc-5gX1.js';
|
|
11
11
|
import './dev-handshake/index.js';
|
|
12
12
|
|
|
@@ -25,6 +25,40 @@ declare const FUNCTION_RUN_FAILURES: readonly ['threw', 'exceeded-cpu', 'exceede
|
|
|
25
25
|
/** Why a run ended without an answer: one of {@link FUNCTION_RUN_FAILURES}. */
|
|
26
26
|
type FunctionRunFailure$1 = (typeof FUNCTION_RUN_FAILURES)[number];
|
|
27
27
|
|
|
28
|
+
/**
|
|
29
|
+
* The End-user token a request carries, read **one** way wherever it is read (spec 4, REL-3880).
|
|
30
|
+
*
|
|
31
|
+
* A customer's app sends the token its identity provider minted for the person signed in to it in
|
|
32
|
+
* `X-RelyIO-End-User`, beside its key. `apps/services/api` verifies it against the Environment's
|
|
33
|
+
* identity source and answers as that End user; `apps/edge/api` never looks up or stores a response
|
|
34
|
+
* to a request that carries it (`edge-delivery-spec.md`'s withhold list), since that response is one
|
|
35
|
+
* person's. Both read the header here, so "carries a token" is one rule for the cache and the origin:
|
|
36
|
+
* a request the edge passed through as an End user's is one origin answers as an End user's.
|
|
37
|
+
*
|
|
38
|
+
* - The header is matched case-insensitively and its value trimmed. A value that is blank once
|
|
39
|
+
* trimmed is **no token**: the request is the key's alone, as without the header.
|
|
40
|
+
* - It never carries the key, and the key's headers never carry it: `X-API-Key` keeps meaning the
|
|
41
|
+
* key, and `Authorization: Bearer` keeps meaning the key when it is alone (`./credential.ts`).
|
|
42
|
+
*
|
|
43
|
+
* Its refusal is `END_USER_TOKEN_INVALID` (401) with `details.reason`, one of
|
|
44
|
+
* {@link END_USER_TOKEN_REFUSAL_REASONS}.
|
|
45
|
+
*/
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Why an End user's token was refused, as `END_USER_TOKEN_INVALID`'s `details.reason`:
|
|
49
|
+
*
|
|
50
|
+
* - `missing` — the call needs one and carried none: a publishable key's call of a Function declaring
|
|
51
|
+
* `endUsers: 'required'` (spec 4, REL-3892).
|
|
52
|
+
* - `no-identity-source` — the Environment the request is answered in has no identity source: its
|
|
53
|
+
* Project uses no identity Extension, or has no Connection of it for the Environment (nor, for
|
|
54
|
+
* Preview, for Production).
|
|
55
|
+
* - the rest — the verifier's (`@relyio/auth/end-users`): the token is malformed, signed with an
|
|
56
|
+
* algorithm RelyIO does not take, from another issuer, by a key the issuer does not publish, with a
|
|
57
|
+
* signature that does not verify, for another audience, expired, not yet valid, or naming no subject.
|
|
58
|
+
*/
|
|
59
|
+
declare const END_USER_TOKEN_REFUSAL_REASONS: readonly ['missing', 'no-identity-source', 'malformed', 'unsupported-algorithm', 'wrong-issuer', 'unknown-key', 'bad-signature', 'wrong-audience', 'expired', 'not-yet-valid', 'missing-subject'];
|
|
60
|
+
type EndUserTokenRefusalReason = (typeof END_USER_TOKEN_REFUSAL_REASONS)[number];
|
|
61
|
+
|
|
28
62
|
/**
|
|
29
63
|
* What a key may do is in its prefix. A RelyIO project key is
|
|
30
64
|
* `rly_{scope}_{region}_v2_{entropy}_{checksum}`: the scope first, then the region of its project's
|
|
@@ -351,10 +385,10 @@ declare class ConnectionError extends SDKError {
|
|
|
351
385
|
* `details.reason: 'expired'`.
|
|
352
386
|
*
|
|
353
387
|
* `AuthenticationError` was deleted by REL-1471 for the same reason. The
|
|
354
|
-
* vocabulary's
|
|
355
|
-
*
|
|
356
|
-
*
|
|
357
|
-
*
|
|
388
|
+
* vocabulary's 401 codes are `MISSING_API_KEY`, `INVALID_API_KEY` and — since
|
|
389
|
+
* spec 4 — `END_USER_TOKEN_INVALID`, and the mapper throws `MissingApiKeyError`,
|
|
390
|
+
* `InvalidApiKeyError` and `EndUserTokenInvalidError` for them — so a generic
|
|
391
|
+
* 401 class has no refusal left to stand for, and nothing constructs it.
|
|
358
392
|
*/
|
|
359
393
|
declare class AuthorizationError extends SDKError {
|
|
360
394
|
readonly code = "AUTHORIZATION_ERROR";
|
|
@@ -368,6 +402,19 @@ declare class InvalidApiKeyError extends SDKError {
|
|
|
368
402
|
constructor(message?: string, cause?: Error, context?: Record<string, unknown>);
|
|
369
403
|
getUserMessage(): string;
|
|
370
404
|
}
|
|
405
|
+
/**
|
|
406
|
+
* The End user's token the request carried was refused (spec 4, REL-3863): `reason` says why —
|
|
407
|
+
* `expired`, `wrong-audience`, `missing` for a call that needs one, and the rest of
|
|
408
|
+
* `END_USER_TOKEN_REFUSAL_REASONS`. Caught by class, an app signs the shopper in again rather than
|
|
409
|
+
* reading its key as bad.
|
|
410
|
+
*/
|
|
411
|
+
declare class EndUserTokenInvalidError extends SDKError {
|
|
412
|
+
readonly reason: EndUserTokenRefusalReason | undefined;
|
|
413
|
+
readonly code = "END_USER_TOKEN_INVALID";
|
|
414
|
+
readonly retryable = false;
|
|
415
|
+
constructor(message: string, reason: EndUserTokenRefusalReason | undefined, context?: Record<string, unknown>);
|
|
416
|
+
getUserMessage(): string;
|
|
417
|
+
}
|
|
371
418
|
|
|
372
419
|
/**
|
|
373
420
|
* One class per contract code that had none.
|
|
@@ -402,8 +449,11 @@ declare class ReadOnlyKeyError extends SDKError {
|
|
|
402
449
|
getUserMessage(): string;
|
|
403
450
|
}
|
|
404
451
|
/**
|
|
405
|
-
* `PUBLISHABLE_KEY_REFUSED` — a publishable key
|
|
406
|
-
*
|
|
452
|
+
* `PUBLISHABLE_KEY_REFUSED` — a publishable key writing a Record with no End user's token, uploading
|
|
453
|
+
* a Record's File, or calling a Function that does not declare `endUsers` (REL-3771). A browser
|
|
454
|
+
* writes a Record only for a signed-in End user, as the type's write Policy allows (spec 4,
|
|
455
|
+
* REL-3884), and calls a Function only when it opts in (REL-3892): send their token, declare
|
|
456
|
+
* `endUsers` on the Function, or call from your server with a secret key.
|
|
407
457
|
*/
|
|
408
458
|
declare class PublishableKeyRefusedError extends SDKError {
|
|
409
459
|
readonly code = "PUBLISHABLE_KEY_REFUSED";
|
|
@@ -1062,4 +1112,4 @@ declare function snapToLadder(value: number): number;
|
|
|
1062
1112
|
|
|
1063
1113
|
declare const VERSION = "__VERSION__";
|
|
1064
1114
|
|
|
1065
|
-
export { AuthorizationError, Change, type ChangeSource, type ChangeSourceOptions, ChangesExpiredError, ChangesExpiredReason, ConnectionError, EntryMetadata, ErrorMapper, FOLLOW_BACK_OFF_MAX_MS, FOLLOW_RETRY_BASE_MS, FOLLOW_RETRY_MAX_MS, type FollowEnd, type FollowOptions, type FollowResync, type FollowState, type FollowVerdict, FunctionContainersBusyError, FunctionRunFailedError, type FunctionRunFailure, FunctionRunTimedOutError, IMAGE_LADDER, InvalidApiKeyError, type KeyPathSegment, type LanguageSwitcherOption, type LanguageSwitcherOptions, type LiveEdgeEnd, LiveEdgeError, type LocaleMetadata, type LocaleStatus, type LocalizedEntry, MethodNotAllowedError, MissingApiKeyError, NetworkError, PREVIEW_KEY_PREFIX, PUBLISHABLE_KEY_PREFIX, PayloadTooLargeError, PlanFeatureUnavailableError, PublishableKeyRefusedError, RELYIO_CHANGE_EVENT, RELYIO_RESYNC_EVENT, RateLimitError, ReadOnlyKeyError, type RelyIOChangeDetail, type RelyIOResyncDetail, SDKError, ServerError, ServiceIndeterminateError, TimeoutError, TransactionRolledBackError, type TranslationCompleteness, UnknownContractError, UsageQuotaExceededError, VERSION, buildLanguageSwitcher, classifyFollowFailure, estimateTranslationCompleteness, followChanges, formatKeyPath, getAllLocalizedValues, getAvailableLocaleCodes, getDefaultLocale, getFallbackFields, getFieldFallbackLocale, getLocalizedField, getPublishedLocaleCodes, getRequestedLocale, hasLocale, isFieldFallback, isPreviewKey, isPublishableKey, isPublishedInLocale, localeHelpers, needsTranslation, parseKeyPath, snapToLadder };
|
|
1115
|
+
export { AuthorizationError, Change, type ChangeSource, type ChangeSourceOptions, ChangesExpiredError, ChangesExpiredReason, ConnectionError, EndUserTokenInvalidError, EntryMetadata, ErrorMapper, FOLLOW_BACK_OFF_MAX_MS, FOLLOW_RETRY_BASE_MS, FOLLOW_RETRY_MAX_MS, type FollowEnd, type FollowOptions, type FollowResync, type FollowState, type FollowVerdict, FunctionContainersBusyError, FunctionRunFailedError, type FunctionRunFailure, FunctionRunTimedOutError, IMAGE_LADDER, InvalidApiKeyError, type KeyPathSegment, type LanguageSwitcherOption, type LanguageSwitcherOptions, type LiveEdgeEnd, LiveEdgeError, type LocaleMetadata, type LocaleStatus, type LocalizedEntry, MethodNotAllowedError, MissingApiKeyError, NetworkError, PREVIEW_KEY_PREFIX, PUBLISHABLE_KEY_PREFIX, PayloadTooLargeError, PlanFeatureUnavailableError, PublishableKeyRefusedError, RELYIO_CHANGE_EVENT, RELYIO_RESYNC_EVENT, RateLimitError, ReadOnlyKeyError, type RelyIOChangeDetail, type RelyIOResyncDetail, SDKError, ServerError, ServiceIndeterminateError, TimeoutError, TransactionRolledBackError, type TranslationCompleteness, UnknownContractError, UsageQuotaExceededError, VERSION, buildLanguageSwitcher, classifyFollowFailure, estimateTranslationCompleteness, followChanges, formatKeyPath, getAllLocalizedValues, getAvailableLocaleCodes, getDefaultLocale, getFallbackFields, getFieldFallbackLocale, getLocalizedField, getPublishedLocaleCodes, getRequestedLocale, hasLocale, isFieldFallback, isPreviewKey, isPublishableKey, isPublishedInLocale, localeHelpers, needsTranslation, parseKeyPath, snapToLadder };
|
package/dist/index.js
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import './chunk-IY5LSKXU.js';
|
|
2
2
|
export { RICH_TEXT_VOID_TAGS, entryHeadingAnchors, escapeHtml, formatKeyPath, isDeclaredRichTextNode, parseKeyPath, relyioField, renderRichText, richTextHeadingAnchors, richTextHeadingSlug, richTextToHtml, richTextToMarkdown, safeRichTextHref } from './chunk-ZAKEY6DY.js';
|
|
3
|
-
export { defineAssetType, defineContentType, defineLocale, defineQuery, defineSchema, defineSettingsGroup, defineSingleton, fields, fieldset } from './chunk-
|
|
4
|
-
import { LiveEdgeError, SDKError, serviceInstructedDelayMs, isAborted, sleep } from './chunk-
|
|
5
|
-
export { AssetClient, AssetFileBuilder, AssetUploadBuilder, AuthorizationError, BaseValidationError, ChangesExpiredError, ConnectionError, ContentClient, DefaultRetryPolicy, ErrorMapper, FileUploadError, FileValidationError, FunctionContainersBusyError, FunctionRunFailedError, FunctionRunTimedOutError, HttpClient, InvalidApiKeyError, InvalidPayloadError, LIVE_KEEPALIVE_INTERVAL_MS, LIVE_SOCKET_OPEN_TIMEOUT_MS, LiveEdgeError, MethodNotAllowedError, MissingApiKeyError, NetworkError, PREVIEW_KEY_PREFIX, PUBLISHABLE_KEY_PREFIX, PayloadTooLargeError, PlanFeatureUnavailableError, PublishableKeyRefusedError, RateLimitError, ReadOnlyKeyError, RecordsClient, ResourceConflictError, ResourceExpiredError, ResourceNotFoundError, SDKError, ServerError, ServiceIndeterminateError, SettingsClient, SingletonClient, TimeoutError, TransactionRolledBackError, TypedRelyIOClient, UnknownContractError, UsageQuotaExceededError, ValidationError, createClient, createClient as default, isAssetEntry, isMissingEntry, isPreviewKey, isPublishableKey, isReplaySafe, isResourceNotFound, matchRoute, refusedOperationOf, retryPolicyFor, validateFile, versionCheckOf } from './chunk-
|
|
3
|
+
export { defineAssetType, defineContentType, defineLocale, defineQuery, defineSchema, defineSettingsGroup, defineSingleton, fields, fieldset } from './chunk-PZCDJFMA.js';
|
|
4
|
+
import { LiveEdgeError, SDKError, serviceInstructedDelayMs, isAborted, sleep } from './chunk-356SF5Y2.js';
|
|
5
|
+
export { AssetClient, AssetFileBuilder, AssetUploadBuilder, AuthorizationError, BaseValidationError, ChangesExpiredError, ConnectionError, ContentClient, DefaultRetryPolicy, EndUserTokenInvalidError, ErrorMapper, FileUploadError, FileValidationError, FunctionContainersBusyError, FunctionRunFailedError, FunctionRunTimedOutError, HttpClient, InvalidApiKeyError, InvalidPayloadError, LIVE_KEEPALIVE_INTERVAL_MS, LIVE_SOCKET_OPEN_TIMEOUT_MS, LiveEdgeError, MethodNotAllowedError, MissingApiKeyError, NetworkError, PREVIEW_KEY_PREFIX, PUBLISHABLE_KEY_PREFIX, PayloadTooLargeError, PlanFeatureUnavailableError, PublishableKeyRefusedError, RateLimitError, ReadOnlyKeyError, RecordsClient, ResourceConflictError, ResourceExpiredError, ResourceNotFoundError, SDKError, ServerError, ServiceIndeterminateError, SettingsClient, SingletonClient, TimeoutError, TransactionRolledBackError, TypedRelyIOClient, UnknownContractError, UsageQuotaExceededError, ValidationError, createClient, createClient as default, isAssetEntry, isMissingEntry, isPreviewKey, isPublishableKey, isReplaySafe, isResourceNotFound, matchRoute, refusedOperationOf, retryPolicyFor, validateFile, versionCheckOf } from './chunk-356SF5Y2.js';
|
|
6
6
|
export { camelToSnake, createDeferred, debounce, deepClone, generateId, isBrowser, isNode, isPlainObject, isValidEmail, isValidUrl, mergeDeep, omit, pick, retry, sleep, snakeToCamel, throttle, toSafeString } from './chunk-NJQK5STK.js';
|
|
7
7
|
import './chunk-W2A4OTCI.js';
|
|
8
8
|
import './chunk-HDHBYYEY.js';
|
|
9
|
-
import { VISITOR_ADMISSION_RETRY_AFTER_SECONDS } from './chunk-
|
|
9
|
+
import { VISITOR_ADMISSION_RETRY_AFTER_SECONDS } from './chunk-T7LGREB3.js';
|
|
10
10
|
import { __name } from './chunk-DI6KFDBO.js';
|
|
11
11
|
|
|
12
12
|
/* RelyIO SDK - Built with ❤️ by the RelyIO Team */
|
package/dist/preview/index.cjs
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
3
|
var chunk7I3SC7SV_cjs = require('../chunk-7I3SC7SV.cjs');
|
|
4
|
-
var
|
|
4
|
+
var chunkNN45CSPZ_cjs = require('../chunk-NN45CSPZ.cjs');
|
|
5
5
|
require('../chunk-L6DXCKVQ.cjs');
|
|
6
6
|
|
|
7
7
|
|
|
@@ -20,11 +20,11 @@ Object.defineProperty(exports, "previewAtRequest", {
|
|
|
20
20
|
});
|
|
21
21
|
Object.defineProperty(exports, "PREVIEW_DATASET_PREFIX", {
|
|
22
22
|
enumerable: true,
|
|
23
|
-
get: function () { return
|
|
23
|
+
get: function () { return chunkNN45CSPZ_cjs.PREVIEW_DATASET_PREFIX; }
|
|
24
24
|
});
|
|
25
25
|
Object.defineProperty(exports, "previewDatasetSlug", {
|
|
26
26
|
enumerable: true,
|
|
27
|
-
get: function () { return
|
|
27
|
+
get: function () { return chunkNN45CSPZ_cjs.previewDatasetSlug; }
|
|
28
28
|
});
|
|
29
29
|
//# sourceMappingURL=index.cjs.map
|
|
30
30
|
//# sourceMappingURL=index.cjs.map
|
package/dist/preview/index.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { UNKNOWN_PREVIEW_RECHECK_MS, previewAtBuild, previewAtRequest } from '../chunk-HDHBYYEY.js';
|
|
2
|
-
export { PREVIEW_DATASET_PREFIX, previewDatasetSlug } from '../chunk-
|
|
2
|
+
export { PREVIEW_DATASET_PREFIX, previewDatasetSlug } from '../chunk-T7LGREB3.js';
|
|
3
3
|
import '../chunk-DI6KFDBO.js';
|
|
4
4
|
//# sourceMappingURL=index.js.map
|
|
5
5
|
//# sourceMappingURL=index.js.map
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { c$ as paths, d0 as RetryConfig, d1 as MergedRelyIOConfig, d2 as ApiResponse, cR as components, cx as FileUpload } from './define-content-type-C12jh8cY.js';
|
|
2
|
+
import { a as SchemaDefinition } from './define-schema-CK7TtYot.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Where the SDK's transport gets its truth.
|
|
@@ -261,6 +261,8 @@ declare class HttpClient {
|
|
|
261
261
|
protected view?: {
|
|
262
262
|
readonly client: ControlledHttpClient;
|
|
263
263
|
readonly headers: Readonly<Record<string, string>>;
|
|
264
|
+
/** The End user's token function this view asks in place of its client's, when it names one. */
|
|
265
|
+
readonly getToken?: EndUserTokenSource;
|
|
264
266
|
};
|
|
265
267
|
constructor(config: MergedRelyIOConfig);
|
|
266
268
|
protected announce(): void;
|
|
@@ -307,6 +309,10 @@ declare class HttpClient {
|
|
|
307
309
|
* constructor accepts one so that a module-scope client can be evaluated by a
|
|
308
310
|
* build that holds no key (REL-1120) — and so does one whose `setApiKey` was
|
|
309
311
|
* given none.
|
|
312
|
+
*
|
|
313
|
+
* The End user's token is asked for once, after the key is known to be there and before the first
|
|
314
|
+
* attempt — of `getToken`, the nearest view's function, or the configuration's — so every retry
|
|
315
|
+
* of one call sends the token its first attempt sent. See `RelyIOConfig.getToken`.
|
|
310
316
|
*/
|
|
311
317
|
private request;
|
|
312
318
|
/**
|
|
@@ -353,8 +359,13 @@ declare class ControlledHttpClient extends HttpClient {
|
|
|
353
359
|
* retries and `fetch` are this client's as they are when each request is sent, so a later
|
|
354
360
|
* `configure()` or `setApiKey()` on this client reaches the view, and one on the view reaches
|
|
355
361
|
* this client. `client.with({ dataset })` is one (REL-2417).
|
|
362
|
+
*
|
|
363
|
+
* `options.getToken` is the End user's token function the view asks in place of this client's,
|
|
364
|
+
* and of any view it is made from: `client.with({ getToken })` (REL-3882).
|
|
356
365
|
*/
|
|
357
|
-
withHeaders(headers: Readonly<Record<string, string
|
|
366
|
+
withHeaders(headers: Readonly<Record<string, string>>, options?: {
|
|
367
|
+
readonly getToken?: EndUserTokenSource;
|
|
368
|
+
}): ControlledHttpClient;
|
|
358
369
|
/**
|
|
359
370
|
* Run on `config` from now on: every later request — whoever holds this client — is sent to its
|
|
360
371
|
* `baseUrl`, with its headers, key and dataset, its timeout and retries, through its `fetch`, and
|
|
@@ -370,7 +381,7 @@ declare class ControlledHttpClient extends HttpClient {
|
|
|
370
381
|
* Replace the key every later request sends as `X-API-Key`, and the `apiKey` the configuration
|
|
371
382
|
* reports.
|
|
372
383
|
*
|
|
373
|
-
* The key is read the way construction reads it (`
|
|
384
|
+
* The key is read the way construction reads it (`presentCredential`): an absent, empty or blank key is
|
|
374
385
|
* no key, so the header is dropped and the next request is refused with `MissingApiKeyError`
|
|
375
386
|
* before anything is sent. A key header of any other spelling — one given in `headers` — goes
|
|
376
387
|
* too, from the headers sent and from the headers the configuration reports, so the old key is
|
|
@@ -385,6 +396,8 @@ declare class ControlledHttpClient extends HttpClient {
|
|
|
385
396
|
*/
|
|
386
397
|
setApiKey(apiKey: string): void;
|
|
387
398
|
}
|
|
399
|
+
/** What `getToken` is: asked per call, answering the signed-in End user's token or `null`. */
|
|
400
|
+
type EndUserTokenSource = NonNullable<MergedRelyIOConfig['getToken']>;
|
|
388
401
|
/** Everything a request reads off the configuration, replaced whole whenever it changes. */
|
|
389
402
|
interface Connection {
|
|
390
403
|
/**
|
|
@@ -403,8 +416,10 @@ interface Connection {
|
|
|
403
416
|
*
|
|
404
417
|
* A Record is an app's data — an order, a stock level, a cart — written by your server with a
|
|
405
418
|
* secret key and live the moment it lands: no draft, no publication, no locale, no version. A
|
|
406
|
-
* publishable key
|
|
407
|
-
*
|
|
419
|
+
* publishable key lists and gets the Records a Record type's read Policy grants it — anonymously, or
|
|
420
|
+
* as the End user whose token it carries (spec 4, REL-3883) — and creates, updates and deletes them
|
|
421
|
+
* only as that End user, as the type's write Policy allows (REL-3884): RelyIO sets the owner from
|
|
422
|
+
* the token. With no token it writes nothing (`PUBLISHABLE_KEY_REFUSED`).
|
|
408
423
|
*
|
|
409
424
|
* Every body is read from the committed document (`INV-API-CLIENT-IS-DERIVED`): the paths are the
|
|
410
425
|
* document's, and `RecordMetadata` is its schema by name.
|
|
@@ -513,7 +528,8 @@ TUpdate = TInput> {
|
|
|
513
528
|
* Store a Record, live the moment it lands. Values that break the Record type's fields are
|
|
514
529
|
* refused with `ValidationError` naming each field, and nothing is stored. Values a unique set of
|
|
515
530
|
* the type claims, held by another Record, are refused with `ResourceConflictError` — its
|
|
516
|
-
* `blockage` is `{ kind: 'value-taken', facts: { fields, recordId } }` (REL-3782)
|
|
531
|
+
* `blockage` is `{ kind: 'value-taken', facts: { fields, recordId } }` (REL-3782) — with no
|
|
532
|
+
* `recordId` for an End user's write, whose read Policy may hide the holder (REL-3863).
|
|
517
533
|
*/
|
|
518
534
|
create(fields: TInput, options?: RecordCallOptions): Promise<TRecord>;
|
|
519
535
|
/** One page of the Records `where` keeps, newest first unless `sort` names one key. */
|
|
@@ -674,4 +690,4 @@ type RegisteredSchema = Register extends {
|
|
|
674
690
|
schema: infer S extends AnySchemaDefinition;
|
|
675
691
|
} ? S : undefined;
|
|
676
692
|
|
|
677
|
-
export { type AnySchemaDefinition as A, type BaseRecord as B, type RecordBatchOptions as C, DefaultRetryPolicy as D, HttpClient as H, type MatchRouteOptions as M, type QueryOf as Q, type RegisteredSchema as R, type SendOptions as S, type Wire as W, type RecordBatchTarget as a, type RecordBatchResult as b, type
|
|
693
|
+
export { type AnySchemaDefinition as A, type BaseRecord as B, type RecordBatchOptions as C, DefaultRetryPolicy as D, HttpClient as H, type MatchRouteOptions as M, type QueryOf as Q, type RegisteredSchema as R, type SendOptions as S, type Wire as W, type RecordBatchTarget as a, type RecordBatchResult as b, type Register as c, type RecordConditionValue as d, type ApiPath as e, type ApiMethod as f, type ApiSuccessBody as g, type RouteMatch as h, isReplaySafe as i, type RetryPolicy as j, type RetryableRequest as k, RecordsClient as l, matchRoute as m, type RecordCallOptions as n, type RecordFacetBucket as o, type RecordFileBytes as p, type RecordFileUploadOptions as q, retryPolicyFor as r, type RecordList as s, type RecordListOptions as t, type RecordMetadata as u, type RecordReadOptions as v, type RecordUpdateOptions as w, refusedOperationOf as x, type RecordBatchOperation as y, type RecordBatchOperationResult as z };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { c$ as paths, d0 as RetryConfig, d1 as MergedRelyIOConfig, d2 as ApiResponse, cR as components, cx as FileUpload } from './define-content-type-BZ6X8GvL.cjs';
|
|
2
|
+
import { a as SchemaDefinition } from './define-schema-BPlZl4a2.cjs';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Where the SDK's transport gets its truth.
|
|
@@ -261,6 +261,8 @@ declare class HttpClient {
|
|
|
261
261
|
protected view?: {
|
|
262
262
|
readonly client: ControlledHttpClient;
|
|
263
263
|
readonly headers: Readonly<Record<string, string>>;
|
|
264
|
+
/** The End user's token function this view asks in place of its client's, when it names one. */
|
|
265
|
+
readonly getToken?: EndUserTokenSource;
|
|
264
266
|
};
|
|
265
267
|
constructor(config: MergedRelyIOConfig);
|
|
266
268
|
protected announce(): void;
|
|
@@ -307,6 +309,10 @@ declare class HttpClient {
|
|
|
307
309
|
* constructor accepts one so that a module-scope client can be evaluated by a
|
|
308
310
|
* build that holds no key (REL-1120) — and so does one whose `setApiKey` was
|
|
309
311
|
* given none.
|
|
312
|
+
*
|
|
313
|
+
* The End user's token is asked for once, after the key is known to be there and before the first
|
|
314
|
+
* attempt — of `getToken`, the nearest view's function, or the configuration's — so every retry
|
|
315
|
+
* of one call sends the token its first attempt sent. See `RelyIOConfig.getToken`.
|
|
310
316
|
*/
|
|
311
317
|
private request;
|
|
312
318
|
/**
|
|
@@ -353,8 +359,13 @@ declare class ControlledHttpClient extends HttpClient {
|
|
|
353
359
|
* retries and `fetch` are this client's as they are when each request is sent, so a later
|
|
354
360
|
* `configure()` or `setApiKey()` on this client reaches the view, and one on the view reaches
|
|
355
361
|
* this client. `client.with({ dataset })` is one (REL-2417).
|
|
362
|
+
*
|
|
363
|
+
* `options.getToken` is the End user's token function the view asks in place of this client's,
|
|
364
|
+
* and of any view it is made from: `client.with({ getToken })` (REL-3882).
|
|
356
365
|
*/
|
|
357
|
-
withHeaders(headers: Readonly<Record<string, string
|
|
366
|
+
withHeaders(headers: Readonly<Record<string, string>>, options?: {
|
|
367
|
+
readonly getToken?: EndUserTokenSource;
|
|
368
|
+
}): ControlledHttpClient;
|
|
358
369
|
/**
|
|
359
370
|
* Run on `config` from now on: every later request — whoever holds this client — is sent to its
|
|
360
371
|
* `baseUrl`, with its headers, key and dataset, its timeout and retries, through its `fetch`, and
|
|
@@ -370,7 +381,7 @@ declare class ControlledHttpClient extends HttpClient {
|
|
|
370
381
|
* Replace the key every later request sends as `X-API-Key`, and the `apiKey` the configuration
|
|
371
382
|
* reports.
|
|
372
383
|
*
|
|
373
|
-
* The key is read the way construction reads it (`
|
|
384
|
+
* The key is read the way construction reads it (`presentCredential`): an absent, empty or blank key is
|
|
374
385
|
* no key, so the header is dropped and the next request is refused with `MissingApiKeyError`
|
|
375
386
|
* before anything is sent. A key header of any other spelling — one given in `headers` — goes
|
|
376
387
|
* too, from the headers sent and from the headers the configuration reports, so the old key is
|
|
@@ -385,6 +396,8 @@ declare class ControlledHttpClient extends HttpClient {
|
|
|
385
396
|
*/
|
|
386
397
|
setApiKey(apiKey: string): void;
|
|
387
398
|
}
|
|
399
|
+
/** What `getToken` is: asked per call, answering the signed-in End user's token or `null`. */
|
|
400
|
+
type EndUserTokenSource = NonNullable<MergedRelyIOConfig['getToken']>;
|
|
388
401
|
/** Everything a request reads off the configuration, replaced whole whenever it changes. */
|
|
389
402
|
interface Connection {
|
|
390
403
|
/**
|
|
@@ -403,8 +416,10 @@ interface Connection {
|
|
|
403
416
|
*
|
|
404
417
|
* A Record is an app's data — an order, a stock level, a cart — written by your server with a
|
|
405
418
|
* secret key and live the moment it lands: no draft, no publication, no locale, no version. A
|
|
406
|
-
* publishable key
|
|
407
|
-
*
|
|
419
|
+
* publishable key lists and gets the Records a Record type's read Policy grants it — anonymously, or
|
|
420
|
+
* as the End user whose token it carries (spec 4, REL-3883) — and creates, updates and deletes them
|
|
421
|
+
* only as that End user, as the type's write Policy allows (REL-3884): RelyIO sets the owner from
|
|
422
|
+
* the token. With no token it writes nothing (`PUBLISHABLE_KEY_REFUSED`).
|
|
408
423
|
*
|
|
409
424
|
* Every body is read from the committed document (`INV-API-CLIENT-IS-DERIVED`): the paths are the
|
|
410
425
|
* document's, and `RecordMetadata` is its schema by name.
|
|
@@ -513,7 +528,8 @@ TUpdate = TInput> {
|
|
|
513
528
|
* Store a Record, live the moment it lands. Values that break the Record type's fields are
|
|
514
529
|
* refused with `ValidationError` naming each field, and nothing is stored. Values a unique set of
|
|
515
530
|
* the type claims, held by another Record, are refused with `ResourceConflictError` — its
|
|
516
|
-
* `blockage` is `{ kind: 'value-taken', facts: { fields, recordId } }` (REL-3782)
|
|
531
|
+
* `blockage` is `{ kind: 'value-taken', facts: { fields, recordId } }` (REL-3782) — with no
|
|
532
|
+
* `recordId` for an End user's write, whose read Policy may hide the holder (REL-3863).
|
|
517
533
|
*/
|
|
518
534
|
create(fields: TInput, options?: RecordCallOptions): Promise<TRecord>;
|
|
519
535
|
/** One page of the Records `where` keeps, newest first unless `sort` names one key. */
|
|
@@ -674,4 +690,4 @@ type RegisteredSchema = Register extends {
|
|
|
674
690
|
schema: infer S extends AnySchemaDefinition;
|
|
675
691
|
} ? S : undefined;
|
|
676
692
|
|
|
677
|
-
export { type AnySchemaDefinition as A, type BaseRecord as B, type RecordBatchOptions as C, DefaultRetryPolicy as D, HttpClient as H, type MatchRouteOptions as M, type QueryOf as Q, type RegisteredSchema as R, type SendOptions as S, type Wire as W, type RecordBatchTarget as a, type RecordBatchResult as b, type
|
|
693
|
+
export { type AnySchemaDefinition as A, type BaseRecord as B, type RecordBatchOptions as C, DefaultRetryPolicy as D, HttpClient as H, type MatchRouteOptions as M, type QueryOf as Q, type RegisteredSchema as R, type SendOptions as S, type Wire as W, type RecordBatchTarget as a, type RecordBatchResult as b, type Register as c, type RecordConditionValue as d, type ApiPath as e, type ApiMethod as f, type ApiSuccessBody as g, type RouteMatch as h, isReplaySafe as i, type RetryPolicy as j, type RetryableRequest as k, RecordsClient as l, matchRoute as m, type RecordCallOptions as n, type RecordFacetBucket as o, type RecordFileBytes as p, type RecordFileUploadOptions as q, retryPolicyFor as r, type RecordList as s, type RecordListOptions as t, type RecordMetadata as u, type RecordReadOptions as v, type RecordUpdateOptions as w, refusedOperationOf as x, type RecordBatchOperation as y, type RecordBatchOperationResult as z };
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { n as RICH_TEXT_VOID_TAGS, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from '../index-
|
|
1
|
+
export { n as RICH_TEXT_VOID_TAGS, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from '../index-DN0l8RHw.cjs';
|
|
2
2
|
import '../rich-text.d-BWc-5gX1.cjs';
|
|
3
|
-
import '../define-content-type-
|
|
3
|
+
import '../define-content-type-BZ6X8GvL.cjs';
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { n as RICH_TEXT_VOID_TAGS, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from '../index-
|
|
1
|
+
export { n as RICH_TEXT_VOID_TAGS, q as RichTextAnchorsOption, t as RichTextAttributes, u as RichTextBlocksOf, v as RichTextDeclaredOf, w as RichTextDeclaredWriters, x as RichTextEntryLinkOf, y as RichTextEntryLinkOption, j as RichTextHtmlDeclaredWriters, k as RichTextHtmlFieldOption, l as RichTextHtmlOptions, z as RichTextInlineOf, m as RichTextMarkdownOptions, A as RichTextNodeContext, B as RichTextRenderable, C as RichTextRenderableOf, D as RichTextReplaceableNode, E as RichTextTag, F as RichTextTarget, e as entryHeadingAnchors, g as escapeHtml, o as isDeclaredRichTextNode, p as renderRichText, d as richTextHeadingAnchors, f as richTextHeadingSlug, h as richTextToHtml, i as richTextToMarkdown, s as safeRichTextHref } from '../index-C-MymZTe.js';
|
|
2
2
|
import '../rich-text.d-BWc-5gX1.js';
|
|
3
|
-
import '../define-content-type-
|
|
3
|
+
import '../define-content-type-C12jh8cY.js';
|
package/dist/schema/index.cjs
CHANGED
|
@@ -1,165 +1,166 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var chunk5F3YYPLZ_cjs = require('../chunk-5F3YYPLZ.cjs');
|
|
4
|
+
require('../chunk-NN45CSPZ.cjs');
|
|
4
5
|
require('../chunk-L6DXCKVQ.cjs');
|
|
5
6
|
|
|
6
7
|
|
|
7
8
|
|
|
8
9
|
Object.defineProperty(exports, "BUILT_IN_ROLES", {
|
|
9
10
|
enumerable: true,
|
|
10
|
-
get: function () { return
|
|
11
|
+
get: function () { return chunk5F3YYPLZ_cjs.BUILT_IN_ROLES; }
|
|
11
12
|
});
|
|
12
13
|
Object.defineProperty(exports, "BUILT_IN_ROLE_ACTIONS", {
|
|
13
14
|
enumerable: true,
|
|
14
|
-
get: function () { return
|
|
15
|
+
get: function () { return chunk5F3YYPLZ_cjs.BUILT_IN_ROLE_ACTIONS; }
|
|
15
16
|
});
|
|
16
17
|
Object.defineProperty(exports, "CONDITION_OPERATORS", {
|
|
17
18
|
enumerable: true,
|
|
18
|
-
get: function () { return
|
|
19
|
+
get: function () { return chunk5F3YYPLZ_cjs.CONDITION_OPERATORS; }
|
|
19
20
|
});
|
|
20
21
|
Object.defineProperty(exports, "ROLE_ACTIONS", {
|
|
21
22
|
enumerable: true,
|
|
22
|
-
get: function () { return
|
|
23
|
+
get: function () { return chunk5F3YYPLZ_cjs.ROLE_ACTIONS; }
|
|
23
24
|
});
|
|
24
25
|
Object.defineProperty(exports, "and", {
|
|
25
26
|
enumerable: true,
|
|
26
|
-
get: function () { return
|
|
27
|
+
get: function () { return chunk5F3YYPLZ_cjs.and; }
|
|
27
28
|
});
|
|
28
29
|
Object.defineProperty(exports, "buildFallbackChain", {
|
|
29
30
|
enumerable: true,
|
|
30
|
-
get: function () { return
|
|
31
|
+
get: function () { return chunk5F3YYPLZ_cjs.buildFallbackChain; }
|
|
31
32
|
});
|
|
32
33
|
Object.defineProperty(exports, "conditionRoot", {
|
|
33
34
|
enumerable: true,
|
|
34
|
-
get: function () { return
|
|
35
|
+
get: function () { return chunk5F3YYPLZ_cjs.conditionRoot; }
|
|
35
36
|
});
|
|
36
37
|
Object.defineProperty(exports, "defineAssetType", {
|
|
37
38
|
enumerable: true,
|
|
38
|
-
get: function () { return
|
|
39
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineAssetType; }
|
|
39
40
|
});
|
|
40
41
|
Object.defineProperty(exports, "defineContentType", {
|
|
41
42
|
enumerable: true,
|
|
42
|
-
get: function () { return
|
|
43
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineContentType; }
|
|
43
44
|
});
|
|
44
45
|
Object.defineProperty(exports, "defineContentTypeWorkflow", {
|
|
45
46
|
enumerable: true,
|
|
46
|
-
get: function () { return
|
|
47
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineContentTypeWorkflow; }
|
|
47
48
|
});
|
|
48
49
|
Object.defineProperty(exports, "defineLocale", {
|
|
49
50
|
enumerable: true,
|
|
50
|
-
get: function () { return
|
|
51
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineLocale; }
|
|
51
52
|
});
|
|
52
53
|
Object.defineProperty(exports, "defineQuery", {
|
|
53
54
|
enumerable: true,
|
|
54
|
-
get: function () { return
|
|
55
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineQuery; }
|
|
55
56
|
});
|
|
56
57
|
Object.defineProperty(exports, "defineRecordType", {
|
|
57
58
|
enumerable: true,
|
|
58
|
-
get: function () { return
|
|
59
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineRecordType; }
|
|
59
60
|
});
|
|
60
61
|
Object.defineProperty(exports, "defineRole", {
|
|
61
62
|
enumerable: true,
|
|
62
|
-
get: function () { return
|
|
63
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineRole; }
|
|
63
64
|
});
|
|
64
65
|
Object.defineProperty(exports, "defineSchema", {
|
|
65
66
|
enumerable: true,
|
|
66
|
-
get: function () { return
|
|
67
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineSchema; }
|
|
67
68
|
});
|
|
68
69
|
Object.defineProperty(exports, "defineSettingsGroup", {
|
|
69
70
|
enumerable: true,
|
|
70
|
-
get: function () { return
|
|
71
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineSettingsGroup; }
|
|
71
72
|
});
|
|
72
73
|
Object.defineProperty(exports, "defineSingleton", {
|
|
73
74
|
enumerable: true,
|
|
74
|
-
get: function () { return
|
|
75
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineSingleton; }
|
|
75
76
|
});
|
|
76
77
|
Object.defineProperty(exports, "defineView", {
|
|
77
78
|
enumerable: true,
|
|
78
|
-
get: function () { return
|
|
79
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineView; }
|
|
79
80
|
});
|
|
80
81
|
Object.defineProperty(exports, "defineWorkflow", {
|
|
81
82
|
enumerable: true,
|
|
82
|
-
get: function () { return
|
|
83
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineWorkflow; }
|
|
83
84
|
});
|
|
84
85
|
Object.defineProperty(exports, "defineWorkflowStage", {
|
|
85
86
|
enumerable: true,
|
|
86
|
-
get: function () { return
|
|
87
|
+
get: function () { return chunk5F3YYPLZ_cjs.defineWorkflowStage; }
|
|
87
88
|
});
|
|
88
89
|
Object.defineProperty(exports, "fields", {
|
|
89
90
|
enumerable: true,
|
|
90
|
-
get: function () { return
|
|
91
|
+
get: function () { return chunk5F3YYPLZ_cjs.fields; }
|
|
91
92
|
});
|
|
92
93
|
Object.defineProperty(exports, "fieldset", {
|
|
93
94
|
enumerable: true,
|
|
94
|
-
get: function () { return
|
|
95
|
+
get: function () { return chunk5F3YYPLZ_cjs.fieldset; }
|
|
95
96
|
});
|
|
96
97
|
Object.defineProperty(exports, "findDefaultLocale", {
|
|
97
98
|
enumerable: true,
|
|
98
|
-
get: function () { return
|
|
99
|
+
get: function () { return chunk5F3YYPLZ_cjs.findDefaultLocale; }
|
|
99
100
|
});
|
|
100
101
|
Object.defineProperty(exports, "findWorkflowStage", {
|
|
101
102
|
enumerable: true,
|
|
102
|
-
get: function () { return
|
|
103
|
+
get: function () { return chunk5F3YYPLZ_cjs.findWorkflowStage; }
|
|
103
104
|
});
|
|
104
105
|
Object.defineProperty(exports, "getActiveLocales", {
|
|
105
106
|
enumerable: true,
|
|
106
|
-
get: function () { return
|
|
107
|
+
get: function () { return chunk5F3YYPLZ_cjs.getActiveLocales; }
|
|
107
108
|
});
|
|
108
109
|
Object.defineProperty(exports, "getBuiltInRoleActions", {
|
|
109
110
|
enumerable: true,
|
|
110
|
-
get: function () { return
|
|
111
|
+
get: function () { return chunk5F3YYPLZ_cjs.getBuiltInRoleActions; }
|
|
111
112
|
});
|
|
112
113
|
Object.defineProperty(exports, "getFirstWorkflowStage", {
|
|
113
114
|
enumerable: true,
|
|
114
|
-
get: function () { return
|
|
115
|
+
get: function () { return chunk5F3YYPLZ_cjs.getFirstWorkflowStage; }
|
|
115
116
|
});
|
|
116
117
|
Object.defineProperty(exports, "getLocaleCodes", {
|
|
117
118
|
enumerable: true,
|
|
118
|
-
get: function () { return
|
|
119
|
+
get: function () { return chunk5F3YYPLZ_cjs.getLocaleCodes; }
|
|
119
120
|
});
|
|
120
121
|
Object.defineProperty(exports, "getNextWorkflowStage", {
|
|
121
122
|
enumerable: true,
|
|
122
|
-
get: function () { return
|
|
123
|
+
get: function () { return chunk5F3YYPLZ_cjs.getNextWorkflowStage; }
|
|
123
124
|
});
|
|
124
125
|
Object.defineProperty(exports, "getWorkflowStageIds", {
|
|
125
126
|
enumerable: true,
|
|
126
|
-
get: function () { return
|
|
127
|
+
get: function () { return chunk5F3YYPLZ_cjs.getWorkflowStageIds; }
|
|
127
128
|
});
|
|
128
129
|
Object.defineProperty(exports, "isBuiltInRole", {
|
|
129
130
|
enumerable: true,
|
|
130
|
-
get: function () { return
|
|
131
|
+
get: function () { return chunk5F3YYPLZ_cjs.isBuiltInRole; }
|
|
131
132
|
});
|
|
132
133
|
Object.defineProperty(exports, "isFinalWorkflowStage", {
|
|
133
134
|
enumerable: true,
|
|
134
|
-
get: function () { return
|
|
135
|
+
get: function () { return chunk5F3YYPLZ_cjs.isFinalWorkflowStage; }
|
|
135
136
|
});
|
|
136
137
|
Object.defineProperty(exports, "isLocaleDefinition", {
|
|
137
138
|
enumerable: true,
|
|
138
|
-
get: function () { return
|
|
139
|
+
get: function () { return chunk5F3YYPLZ_cjs.isLocaleDefinition; }
|
|
139
140
|
});
|
|
140
141
|
Object.defineProperty(exports, "isRoleDefinition", {
|
|
141
142
|
enumerable: true,
|
|
142
|
-
get: function () { return
|
|
143
|
+
get: function () { return chunk5F3YYPLZ_cjs.isRoleDefinition; }
|
|
143
144
|
});
|
|
144
145
|
Object.defineProperty(exports, "isWorkflowDefinition", {
|
|
145
146
|
enumerable: true,
|
|
146
|
-
get: function () { return
|
|
147
|
+
get: function () { return chunk5F3YYPLZ_cjs.isWorkflowDefinition; }
|
|
147
148
|
});
|
|
148
149
|
Object.defineProperty(exports, "isWorkflowStageDefinition", {
|
|
149
150
|
enumerable: true,
|
|
150
|
-
get: function () { return
|
|
151
|
+
get: function () { return chunk5F3YYPLZ_cjs.isWorkflowStageDefinition; }
|
|
151
152
|
});
|
|
152
153
|
Object.defineProperty(exports, "not", {
|
|
153
154
|
enumerable: true,
|
|
154
|
-
get: function () { return
|
|
155
|
+
get: function () { return chunk5F3YYPLZ_cjs.not; }
|
|
155
156
|
});
|
|
156
157
|
Object.defineProperty(exports, "or", {
|
|
157
158
|
enumerable: true,
|
|
158
|
-
get: function () { return
|
|
159
|
+
get: function () { return chunk5F3YYPLZ_cjs.or; }
|
|
159
160
|
});
|
|
160
161
|
Object.defineProperty(exports, "rollup", {
|
|
161
162
|
enumerable: true,
|
|
162
|
-
get: function () { return
|
|
163
|
+
get: function () { return chunk5F3YYPLZ_cjs.rollup; }
|
|
163
164
|
});
|
|
164
165
|
//# sourceMappingURL=index.cjs.map
|
|
165
166
|
//# sourceMappingURL=index.cjs.map
|