foldkit-remote 0.16.0 → 0.18.0

package/dist/{src-oVKXbiTu.mjs → src-Cp71fJac.mjs}

@@ -740,6 +740,16 @@ var RemoteForbidden = class extends Schema.TaggedError()("Forbidden", {
 	message: Schema.String,
 	reason: Schema.optional(Schema.String)
 }) {};
+/**
+* The server could not tell who is asking: a credential was sent and no
+* longer holds, or none was sent where one is needed. Asking again as the
+* same caller is refused again; signing in again is the remedy. `reason` is
+* words for the person who asked; without it the refusal says nothing of why.
+*/
+var RemoteUnauthenticated = class extends Schema.TaggedError()("Unauthenticated", {
+	message: Schema.String,
+	reason: Schema.optional(Schema.String)
+}) {};
 var RemoteLiveError = class extends Schema.TaggedError()("RemoteLiveError", { message: Schema.String }) {};
 /** The peer speaks another protocol version; nothing was read. */
 var RemoteProtocolError = class extends Schema.TaggedError()("RemoteProtocolError", {
@@ -894,17 +904,29 @@ const LiveChange = Schema.Union([
 const Read = Rpc.make("FoldkitRemoteRead", {
 	payload: ReadBatch,
 	success: ReadBatchResult,
-	error: Schema.Union([RemoteReadError, RemoteProtocolError])
+	error: Schema.Union([
+		RemoteReadError,
+		RemoteProtocolError,
+		RemoteUnauthenticated
+	])
 });
 const Mutate = Rpc.make("FoldkitRemoteMutate", {
 	payload: MutationRequest,
 	success: MutationResult,
-	error: Schema.Union([RemoteMutationError, RemoteForbidden])
+	error: Schema.Union([
+		RemoteMutationError,
+		RemoteForbidden,
+		RemoteUnauthenticated
+	])
 });
 const Live = Rpc.make("FoldkitRemoteLive", {
 	payload: LiveRequirement,
 	success: LiveChange,
-	error: Schema.Union([RemoteLiveError, RemoteProtocolError]),
+	error: Schema.Union([
+		RemoteLiveError,
+		RemoteProtocolError,
+		RemoteUnauthenticated
+	]),
 	stream: true
 });
 var RemoteQueryError = class extends Schema.TaggedError()("RemoteQueryError", { message: Schema.String }) {};
@@ -947,7 +969,7 @@ const QueryResult = Schema.Struct({
 const QueryRpc = Rpc.make("FoldkitRemoteQuery", {
 	payload: QueryRequest,
 	success: QueryResult,
-	error: RemoteQueryError
+	error: Schema.Union([RemoteQueryError, RemoteUnauthenticated])
 });
 const RemoteRpc = RpcGroup.make(Read, Mutate, QueryRpc, Live);
 //#endregion
@@ -2686,6 +2708,23 @@ const RemotePersistence = {
 //#endregion
 //#region src/remoteData.ts
 /** `RemoteData`: the state of a value the store may not hold yet. */
+/**
+* The server would not answer who is asking: their session ended or was
+* never there (`Unauthenticated`, a 401), or they may not (`Forbidden`, a
+* 403). `reason` is the server's sentence, when it gave one. Not a mutation's
+* declared `refusal`, which the server answered and `Data.refusal` reads.
+*/
+const Denied = defineTaggedUnion({
+	Unauthenticated: { reason: Schema.Option(Schema.String) },
+	Forbidden: { reason: Schema.Option(Schema.String) }
+});
+/** The tags `denied` reads: a `RemoteError`'s `_tag` is open, for any failure a transport reports. */
+const denials = /* @__PURE__ */ new Set(["Unauthenticated", "Forbidden"]);
+const isDenial = (tag) => denials.has(tag);
+const deny = {
+	Unauthenticated: Denied.Unauthenticated,
+	Forbidden: Denied.Forbidden
+};
 const fresh = { _tag: "Fresh" };
 const refreshing = { _tag: "Refreshing" };
 const remoteErrorSchema = Schema.Struct({
@@ -2786,6 +2825,19 @@ const RemoteData = {
 			});
 		}
 	},
+	/**
+	* The denial a failure was, typed, or none for any other failure (a
+	* network error, a protocol mismatch): what to read before telling a reader
+	* to sign in again.
+	*
+	* ```ts
+	* Option.match(RemoteData.denied(error), {
+	*   onNone: () => 'Could not load',
+	*   onSome: Denied.match({ Unauthenticated: () => 'Sign in again', Forbidden: () => 'Not yours' }),
+	* })
+	* ```
+	*/
+	denied: (error) => isDenial(error._tag) ? Option.some(deny[error._tag]({ reason: Option.fromUndefinedOr(error.reason) })) : Option.none(),
 	map: (data, f) => {
 		switch (data._tag) {
 			case "Ready": return {
@@ -3965,7 +4017,9 @@ const RemoteJsonAnswer = Schema.Union([Schema.Struct({ result: Schema.Unknown })
 	error: Schema.String,
 	refusal: Schema.optional(Schema.Unknown),
 	/** Who is asking was refused, with the application's reason when it gave one. */
-	forbidden: Schema.optional(Schema.Struct({ reason: Schema.optional(Schema.String) }))
+	forbidden: Schema.optional(Schema.Struct({ reason: Schema.optional(Schema.String) })),
+	/** Who is asking could not be told, with the reason when one was given; a 401. */
+	unauthenticated: Schema.optional(Schema.Struct({ reason: Schema.optional(Schema.String) }))
 })]);
 const decodeAnswer = Schema.decodeUnknownEffect(RemoteJsonAnswer);
 const call = (send, operation, payload, fail) => Effect.tryPromise({
@@ -3975,26 +4029,57 @@ const call = (send, operation, payload, fail) => Effect.tryPromise({
 	})),
 	catch: (error) => fail({ error: error instanceof Error ? error.message : String(error) })
 }).pipe(Effect.flatMap((answer) => decodeAnswer(answer).pipe(Effect.mapError(() => fail({ error: "The server answered with something that is not an answer" })))), Effect.flatMap((answer) => "error" in answer ? Effect.fail(fail(answer)) : Effect.succeed(answer.result)));
+/**
+* An error answer as its call's failure: a refusal of who is asking, of
+* every call kind alike, or the call's own error.
+*/
+const failure = (own) => (answer) => answer.unauthenticated === void 0 ? own(answer) : new RemoteUnauthenticated({
+	message: answer.error,
+	...answer.unauthenticated.reason === void 0 ? {} : { reason: answer.unauthenticated.reason }
+});
 /** Remote's client over `send`, for `Remote.clientLayer`. */
 const json = (send) => ({
-	FoldkitRemoteRead: (payload) => call(send, "read", payload, ({ error }) => new RemoteReadError({ message: error })),
-	FoldkitRemoteQuery: (payload) => call(send, "query", payload, ({ error }) => new RemoteQueryError({ message: error })),
-	FoldkitRemoteMutate: (payload) => call(send, "mutate", payload, ({ error, refusal, forbidden }) => forbidden === void 0 ? new RemoteMutationError({
+	FoldkitRemoteRead: (payload) => call(send, "read", payload, failure(({ error }) => new RemoteReadError({ message: error }))),
+	FoldkitRemoteQuery: (payload) => call(send, "query", payload, failure(({ error }) => new RemoteQueryError({ message: error }))),
+	FoldkitRemoteMutate: (payload) => call(send, "mutate", payload, failure(({ error, refusal, forbidden }) => forbidden === void 0 ? new RemoteMutationError({
 		message: error,
 		refusal
 	}) : new RemoteForbidden({
 		message: error,
 		...forbidden.reason === void 0 ? {} : { reason: forbidden.reason }
-	})),
+	}))),
 	FoldkitRemoteLive: () => Stream.empty
 });
 /** A body that did not parse, told apart from every value one can parse to, `null` included. */
 const notJson = Symbol("not JSON");
+const Reason = Schema.Struct({ reason: Schema.optional(Schema.String) });
+/** A refusal in Remote's own words, by the key it is given under. */
+const ownRefusal = {
+	unauthenticated: Schema.decodeUnknownOption(Schema.Struct({
+		error: Schema.String,
+		unauthenticated: Reason
+	})),
+	forbidden: Schema.decodeUnknownOption(Schema.Struct({
+		error: Schema.String,
+		forbidden: Reason
+	}))
+};
+/**
+* A 401's or 403's answer, whatever its body: Remote's own refusal as it is,
+* and anything else (`{ error }` from middleware, HTML, a shape of its own)
+* as the status alone, so it never reaches a decoder that would call it a
+* broken answer.
+*/
+const refusalOf = (body, kind, status) => Option.getOrElse(ownRefusal[kind](body), () => ({
+	error: status,
+	[kind]: {}
+}));
 /**
 * Remote's client over HTTP: each call a `POST` of the request to `url`, the
-* answer its JSON body whatever its status. A 403 is answered as forbidden
-* unless its body says so itself, as the server's own does: one from
-* middleware in front of Remote (a refused session) may say only `{ error }`.
+* answer its JSON body whatever its status. A 401 is answered as
+* unauthenticated, for every call kind, and a 403 as forbidden, whatever the
+* body says: the server's own says why, and middleware in front of Remote
+* may say anything.
 * `headers` is read per request, so a token that changes reaches the next
 * call. `fetch` defaults to the global one; pass it to route calls through
 * another implementation in tests.
@@ -4010,11 +4095,8 @@ const http = (url, options = {}) => json(async (request) => {
 	});
 	const status = `${response.status} ${response.statusText}`;
 	const body = await response.json().catch(() => notJson);
-	const saysForbidden = typeof body === "object" && body !== null && Object.hasOwn(body, "forbidden");
-	if (response.status === 403 && !saysForbidden) return {
-		error: status,
-		forbidden: {}
-	};
+	if (response.status === 401) return refusalOf(body, "unauthenticated", status);
+	if (response.status === 403) return refusalOf(body, "forbidden", status);
 	if (body === notJson) throw new Error(status);
 	return body;
 });
@@ -4079,13 +4161,21 @@ async function* changes(body) {
 		if (frame.data.length === 0) continue;
 		const text = frame.data.join("\n");
 		if (frame.event === "error") {
-			const message = JSON.parse(text).message;
-			throw new RemoteLiveError({ message: typeof message === "string" ? message : text });
+			const said = JSON.parse(text);
+			const message = Predicate.isObject(said) && typeof said.message === "string" ? said.message : text;
+			if (Predicate.isObject(said) && Predicate.isObject(said.unauthenticated)) {
+				const reason = said.unauthenticated.reason;
+				throw new RemoteUnauthenticated({
+					message,
+					...typeof reason === "string" ? { reason } : {}
+				});
+			}
+			throw new RemoteLiveError({ message });
 		}
 		yield decodeChange(JSON.parse(text));
 	}
 }
-const liveError = (error) => error instanceof RemoteLiveError ? error : new RemoteLiveError({ message: error instanceof Error ? error.message : String(error) });
+const liveError = (error) => error instanceof RemoteLiveError || error instanceof RemoteUnauthenticated ? error : new RemoteLiveError({ message: error instanceof Error ? error.message : String(error) });
 /** Remote's live stream over fetch: `serveFetch`'s live open as a `Stream`. */
 const liveFetch = (url, options = {}) => (payload) => Stream.unwrap(Effect.gen(function* () {
 	const via = options.fetch ?? fetch;
@@ -4110,7 +4200,15 @@ const liveFetch = (url, options = {}) => (payload) => Stream.unwrap(Effect.gen(f
 			try: () => response.json().catch(() => null),
 			catch: liveError
 		});
-		return yield* new RemoteLiveError({ message: Predicate.isObject(answered) && "error" in answered ? String(answered.error) : `HTTP ${response.status} ${response.statusText}` });
+		const message = Predicate.isObject(answered) && "error" in answered ? String(answered.error) : `HTTP ${response.status} ${response.statusText}`;
+		if (response.status === 401) {
+			const said = Predicate.isObject(answered) && Predicate.isObject(answered.unauthenticated) ? answered.unauthenticated.reason : void 0;
+			return yield* new RemoteUnauthenticated({
+				message,
+				...typeof said === "string" ? { reason: said } : {}
+			});
+		}
+		return yield* new RemoteLiveError({ message });
 	}
 	if (response.body === null) return yield* new RemoteLiveError({ message: "The server answered live with no body" });
 	return Stream.fromAsyncIterable(changes(response.body), liveError);
@@ -6112,7 +6210,7 @@ const bindDomain = (definition, store, options = {}) => {
 		},
 		wiring: (active, options) => ({
 			key: `remote:${bound.contract.name}`,
-			handles: Object.keys(remoteMessageCases),
+			handles: Record.keys(remoteMessageCases),
 			route: (model, message) => isRemoteMessage(message) ? Option.some({ model: reduce(model, message) }) : Option.none(),
 			subscriptions: brandEntries(domain.subscriptions(active, options)),
 			contract: bound.contract
@@ -6156,6 +6254,6 @@ const pickWindow = (window) => ({
 	...window.before === void 0 ? {} : { before: window.before }
 });
 //#endregion
-export { pruneOverlays as $, relationAlias as $n, QueryRpc as $t, writeRead as A, emptyStore as An, coalescedLayer as At, windowKey as B, remove as Bn, LiveChange as Bt, remoteMessageCases as C, failMutation as Cn, isGapped as Ct, updateRemote as D, reconcileMutation as Dn, terminal as Dt, retentionRootsSchema as E, patchOfWrite as En, segment as Et, RemotePersistence as F, isFieldUnavailable as Fn, coalesceQueries as Ft, liveHasNext as G, writeEntity as Gn, Mutate as Gt, applyEntityEvent as H, setUnavailable as Hn, LiveRequirement as Ht, gc as I, isTombstone as In, coalesceReads as It, addLayer as J, RelationEntityAnnotation as Jn, NormalizedEntity as Jt, liveHasPrevious as K, RELATION_ALIAS as Kn, MutationRequest as Kt, reachable as L, markStale as Ln, requirementKey as Lt, remoteDataSchema as M, entry as Mn, liveEventOf as Mt, remoteErrorSchema as N, hasField as Nn, mutateRemote as Nt, windowGrowthKey as O, schemaOf as On, unknown as Ot, REMOTE_CACHE_VERSION as P, isFieldStale as Pn, remoteError as Pt, emptyOptimistic as Q, refsIn as Qn, QueryResult as Qt, deadlineOf as R, missingFields as Rn, ConnectionChangeSchema as Rt, refreshedAt as S, emptyMutationState as Sn, hasPrevious as St, remoteModelSchema as T, optimisticOfWrite as Tn, merge as Tt, classifyLive as U, tombstone as Un, MAX_FIELDS_PER_REQUEST as Ut, applyConnectionEvent as V, setStale as Vn, LiveEdge as Vt, emptyLiveState as W, writeEntities as Wn, MAX_RELATION_DEPTH as Wt, beginOptimistic as X, isRefPage as Xn, QueryEdge as Xt, addOverlay as Y, aliasedField as Yn, PageSize as Yt, connectionIdentity as Z, refParts as Zn, QueryRequest as Zt, isRemoteMessage as _, Query$1 as _n, unavailableOf as _t, RemoteJsonAnswer as a, RelationRequest as an, connectionsOf as ar, visibleStore as at, overlaysOf as b, Refusal as bn, emptyConnection as bt, emptyRefresh as c, RemoteMutationError as cn, belongsEncoded as ct, initialRemoteModel as d, RemoteReadError as dn, placeIn as dt, REMOTE_PROTOCOL_VERSION as en, relationShape as er, removeLayer as et, invalidateConnections as f, RemoteRpc as fn, Entity$1 as ft, isQueryLoading as g, IDENTITY_SEPARATOR as gn, relationOf as gt, isLoadingThrough as h, WireBoundary as hn, pageSchema as ht, liveFetch as i, ReadRequest as in, Requirement as ir, visibleItems as it, RemoteData as j, entityKey as jn, connectionChangeOf as jt, withRefreshRequested as k, clearStale as kn, RemoteClient as kt, failureOf as l, RemoteProtocolError as ln, matching as lt, isLoading as m, WindowSchema as mn, assemble as mt, RemoteUnsatisfied as n, ReadBatch as nn, RemoteConnections as nr, settleFailure as nt, RemoteJsonRequest as o, RemoteForbidden as on, requirementsOf as or, inspectEntity as ot, isFieldFailed as p, SettledFields as pn, Selection as pt, ConnectionChange as q, RelationAnnotation as qn, MutationResult as qt, httpWithLive as r, ReadBatchResult as rn, RemoteRequirements as rr, settleSuccess as rt, RemotePolicy as s, RemoteLiveError as sn, inspectRemote as st, Remote as t, Read as tn, targetsOf as tr, removeOverlay as tt, forgetRemote as u, RemoteQueryError as un, RowPlace as ut, noFailures as v, stableStringify as vn, cursor as vt, remoteMessageSchema as w, mutationStatus as wn, items as wt, refreshIsInFlight as x, beginMutation as xn, hasNext as xt, onlyOverlaid as y, Mutation as yn, edge as yt, plan as z, readField as zn, Live as zt };
+export { emptyOptimistic as $, refParts as $n, QueryResult as $t, writeRead as A, schemaOf as An, RemoteClient as At, plan as B, missingFields as Bn, Live as Bt, remoteMessageCases as C, beginMutation as Cn, hasPrevious as Ct, updateRemote as D, optimisticOfWrite as Dn, segment as Dt, retentionRootsSchema as E, mutationStatus as En, merge as Et, REMOTE_CACHE_VERSION as F, hasField as Fn, remoteError as Ft, emptyLiveState as G, tombstone as Gn, MAX_RELATION_DEPTH as Gt, applyConnectionEvent as H, remove as Hn, LiveEdge as Ht, RemotePersistence as I, isFieldStale as In, coalesceQueries as It, ConnectionChange as J, RELATION_ALIAS as Jn, MutationResult as Jt, liveHasNext as K, writeEntities as Kn, Mutate as Kt, gc as L, isFieldUnavailable as Ln, coalesceReads as Lt, RemoteData as M, emptyStore as Mn, connectionChangeOf as Mt, remoteDataSchema as N, entityKey as Nn, liveEventOf as Nt, windowGrowthKey as O, patchOfWrite as On, terminal as Ot, remoteErrorSchema as P, entry as Pn, mutateRemote as Pt, connectionIdentity as Q, isRefPage as Qn, QueryRequest as Qt, reachable as R, isTombstone as Rn, requirementKey as Rt, refreshedAt as S, Refusal as Sn, hasNext as St, remoteModelSchema as T, failMutation as Tn, items as Tt, applyEntityEvent as U, setStale as Un, LiveRequirement as Ut, windowKey as V, readField as Vn, LiveChange as Vt, classifyLive as W, setUnavailable as Wn, MAX_FIELDS_PER_REQUEST as Wt, addOverlay as X, RelationEntityAnnotation as Xn, PageSize as Xt, addLayer as Y, RelationAnnotation as Yn, NormalizedEntity as Yt, beginOptimistic as Z, aliasedField as Zn, QueryEdge as Zt, isRemoteMessage as _, WireBoundary as _n, relationOf as _t, RemoteJsonAnswer as a, ReadRequest as an, RemoteRequirements as ar, visibleItems as at, overlaysOf as b, stableStringify as bn, edge as bt, emptyRefresh as c, RemoteLiveError as cn, requirementsOf as cr, inspectRemote as ct, initialRemoteModel as d, RemoteQueryError as dn, RowPlace as dt, QueryRpc as en, refsIn as er, pruneOverlays as et, invalidateConnections as f, RemoteReadError as fn, placeIn as ft, isQueryLoading as g, WindowSchema as gn, pageSchema as gt, isLoadingThrough as h, SettledFields as hn, assemble as ht, liveFetch as i, ReadBatchResult as in, RemoteConnections as ir, settleSuccess as it, Denied as j, clearStale as jn, coalescedLayer as jt, withRefreshRequested as k, reconcileMutation as kn, unknown as kt, failureOf as l, RemoteMutationError as ln, belongsEncoded as lt, isLoading as m, RemoteUnauthenticated as mn, Selection as mt, RemoteUnsatisfied as n, Read as nn, relationShape as nr, removeOverlay as nt, RemoteJsonRequest as o, RelationRequest as on, Requirement as or, visibleStore as ot, isFieldFailed as p, RemoteRpc as pn, Entity$1 as pt, liveHasPrevious as q, writeEntity as qn, MutationRequest as qt, httpWithLive as r, ReadBatch as rn, targetsOf as rr, settleFailure as rt, RemotePolicy as s, RemoteForbidden as sn, connectionsOf as sr, inspectEntity as st, Remote as t, REMOTE_PROTOCOL_VERSION as tn, relationAlias as tr, removeLayer as tt, forgetRemote as u, RemoteProtocolError as un, matching as ut, noFailures as v, IDENTITY_SEPARATOR as vn, unavailableOf as vt, remoteMessageSchema as w, emptyMutationState as wn, isGapped as wt, refreshIsInFlight as x, Mutation as xn, emptyConnection as xt, onlyOverlaid as y, Query$1 as yn, cursor as yt, deadlineOf as z, markStale as zn, ConnectionChangeSchema as zt };
 
-//# sourceMappingURL=src-oVKXbiTu.mjs.map
+//# sourceMappingURL=src-Cp71fJac.mjs.map