apps 0.0.1-beta.88 → 0.0.1-beta.89

package/types/apps/src/contracts/host.d.ts

@@ -23,7 +23,7 @@ export * from "./events.js";
 export { AppIcon, AppIcons, appIconLimits } from "./icons.js";
 export * from "./placement.js";
 export { AccountId, HttpUrl } from "./schema.js";
-export { OAuthAuthorizationParams, OAuthClientAuth, OAuthSecretClientAuth, OAuthTokenRequestFormat, OAuthTokenResponse, } from "./provider.js";
+export { OAuthAuthorizationParams, OAuthClientAuth, OAuthSecretClientAuth, OAuthTokenRequestFormat, OAuthTokenResponse, reservedAuthorizationParams, type ReservedAuthorizationParam, } from "./provider.js";
 /**
  * The host protocol this framework speaks and its wire schemas, from `protocols/current.ts`. The
  * released protocol modules are frozen records that host adapters read.

package/types/apps/src/contracts/schema.d.ts

@@ -12,6 +12,27 @@ export declare const AccountId: Schema.brand<Schema.String, "acc">;
 export type AccountId = typeof AccountId.Type;
 /** Absolute HTTP(S) URL; local HTTP hosts are supported. */
 export declare const HttpUrl: Schema.String;
+/** One problem with a declaration: where in it, and what is wrong there. */
+export declare const DeclarationIssue: Schema.Struct<{
+    readonly path: Schema.$Array<Schema.String>;
+    readonly message: Schema.String;
+}>;
+export type DeclarationIssue = typeof DeclarationIssue.Type;
+declare const DeclarationInvalid_base: Schema.Class<DeclarationInvalid, Schema.TaggedStruct<"DeclarationInvalid", {
+    readonly declaration: Schema.String;
+    readonly issues: Schema.$Array<Schema.Struct<{
+        readonly path: Schema.$Array<Schema.String>;
+        readonly message: Schema.String;
+    }>>;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * An author's declaration, such as the options of `oauth2()`, did not match its schema. Unlike
+ * {@link ValidationError} it names each failing path and problem, because the value is the
+ * author's own source. Messages never include supplied values.
+ */
+export declare class DeclarationInvalid extends DeclarationInvalid_base {
+    get message(): string;
+}
 declare const ValidationError_base: Schema.Class<ValidationError, Schema.TaggedStruct<"ValidationError", {}>, import("effect/Cause").YieldableError>;
 /** Invalid input. Never includes supplied values, credentials or response bodies. */
 export declare class ValidationError extends ValidationError_base {

package/types/apps/src/implementation/openapi-compile.d.ts

@@ -25,12 +25,13 @@ export declare const compileOpenApiDocument: (entry: OpenApiImport, inputDocumen
     readonly fallbackSecurity?: GeneratedOperation["request"]["security"];
 }) => Effect.Effect<{
     operations: {
+        readonly path: string;
         readonly method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "QUERY";
         readonly description: string;
         readonly name: string;
         readonly request: {
             readonly parameters: readonly {
-                readonly in: "header" | "query" | "path" | "querystring" | "cookie";
+                readonly in: "path" | "header" | "query" | "querystring" | "cookie";
                 readonly name: string;
                 readonly required?: boolean;
                 readonly schema?: {
@@ -66,7 +67,6 @@ export declare const compileOpenApiDocument: (entry: OpenApiImport, inputDocumen
                 readonly required?: boolean;
             };
         };
-        readonly path: string;
         readonly input: {
             readonly [x: string]: Schema.Json;
         };

package/types/apps/src/implementation/provider.d.ts

@@ -3,7 +3,7 @@ import { Effect, Schema } from "effect";
 import { type PromiseMethod } from "./authoring.js";
 import { type AccountCheck, type AuthMethods, type FieldExposure, OAuth2Config, OAuth2Method, Provider, SecretsMethod } from "../contracts/provider.js";
 import type { Placement } from "../contracts/placement.js";
-import type { ValidationError } from "../contracts/schema.js";
+import type { DeclarationInvalid } from "../contracts/schema.js";
 /** Declare a secrets method with an Effect decoder. */
 export declare const secrets: <Fields extends Schema.Decoder<unknown>>(options: {
     readonly label: string;
@@ -12,7 +12,7 @@ export declare const secrets: <Fields extends Schema.Decoder<unknown>>(options:
     readonly request?: readonly Placement[];
 }) => SecretsMethod<Fields>;
 /** Validate OAuth endpoints while declaring their app-visible response projection. */
-export declare const oauth2: <Response extends Schema.Decoder<unknown>>(config: OAuth2Config, response: Response, exposure?: Readonly<Record<string, FieldExposure>>, request?: readonly Placement[]) => Effect.Effect<OAuth2Method<Response>, ValidationError>;
+export declare const oauth2: <Response extends Schema.Decoder<unknown>>(config: OAuth2Config, response: Response, exposure?: Readonly<Record<string, FieldExposure>>, request?: readonly Placement[]) => Effect.Effect<OAuth2Method<Response>, DeclarationInvalid>;
 /** Author options: the account check is an ordinary async function. */
 export interface ProviderOptions<Auth extends AuthMethods> {
     readonly name: string;

package/types/apps/src/implementation/schema.d.ts

@@ -1,6 +1,6 @@
 /** Author schema facade. Internals use the native decoder retained by each value. */
 import { Effect, Schema as EffectSchema } from "effect";
-import { JsonObject, ValidationError } from "../contracts/schema.js";
+import { DeclarationInvalid, JsonObject, ValidationError } from "../contracts/schema.js";
 import type { FieldExposure } from "../contracts/provider.js";
 declare const Decoder: unique symbol;
 /** An author-facing value schema. Effect is never required in author code. */
@@ -42,6 +42,13 @@ export declare const isSchema: (value: unknown) => value is Schema<unknown, bool
 export declare const schemaArgument: <S extends Schema<unknown, boolean>>(value: S, role: string) => S;
 /** Decode within an Effect program. Invalid input is omitted from the failure. */
 export declare const parse: <T>(decoder: EffectSchema.Decoder<T>, input: unknown) => Effect.Effect<T, ValidationError>;
+/**
+ * Decode an author's declaration, naming every failing path. A declaration with several forms,
+ * such as `oauth2()`'s discovered, declared and client credentials endpoints, is explained by the
+ * form its author chose (`intended`), so the problems are that form's, including the options it
+ * lacks, rather than every other form's objections. Messages never include the supplied values.
+ */
+export declare const parseDeclaration: <T>(decoder: EffectSchema.Decoder<T>, input: unknown, declaration: string, intended?: (input: unknown) => EffectSchema.Decoder<unknown>) => Effect.Effect<T, DeclarationInvalid>;
 /** Present a native decoder through the synchronous author API. */
 export declare function wrap<T, Optional extends boolean>(decoder: EffectSchema.Decoder<T>, optionalValue: Optional): Schema<T, Optional>;
 /** A string, optionally with a minimum length. No coercion. */

package/types/apps/src/index.d.ts

@@ -17,7 +17,7 @@ import type { Placement } from "./contracts/placement.js";
 import type { AppContext as NativeAppContext, QueryContext as NativeQueryContext } from "./contracts/context.js";
 import { query as operationQuery, type OperationOptions } from "./implementation/operations.js";
 import { type Fields, type Infer, type ObjectSchema, type Schema, type SecretFields, type SecretObject } from "./implementation/schema.js";
-export { type JsonObject, type JsonValue, ValidationError } from "./contracts/schema.js";
+export { DeclarationInvalid, type DeclarationIssue, type JsonObject, type JsonValue, ValidationError, } from "./contracts/schema.js";
 export { type Fields, type Infer, type ObjectSchema, type ObjectValue, type Schema, array, boolean, json, jsonSchema, literal, number, object, record, string, plain, raw, type SecretString, } from "./implementation/schema.js";
 export { type AccountCheckContext, type AccountCheckResult, type AccountInfo, type AccountOf, type AuthMethod, type AuthMethodData, type AuthMethods, type ManyAccounts, type Provider, type ReservedAuthorizationParam, } from "./contracts/provider.js";
 export { defineProvider, type ProviderOptions } from "./implementation/provider.js";