apps 0.0.1-beta.1 → 0.0.1-beta.100

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

@@ -0,0 +1,102 @@
+/**
+ * Credential placement: where an auth method's secret fields may be sent. A placement is a
+ * location in the request, a header or a query parameter, and a value template built from
+ * literal text, references to the method's own account fields, and base64 of those. Executor's
+ * outbound network substitutes a placed credential handle only where a request matches one of
+ * its method's placements exactly, and refuses the request when the handle is anywhere else.
+ */
+import { Result, Schema } from "effect";
+/** A reference to one of the method's own account fields. */
+export declare const PlacementField: Schema.Struct<{
+    readonly field: Schema.NonEmptyString;
+}>;
+export type PlacementField = typeof PlacementField.Type;
+/** Literal text or a field reference: what base64 may encode. Base64 never nests. */
+export declare const PlacementText: Schema.Union<readonly [Schema.String, Schema.Struct<{
+    readonly field: Schema.NonEmptyString;
+}>]>;
+export type PlacementText = typeof PlacementText.Type;
+/** Base64 (RFC 4648, padded) of the UTF-8 bytes of its parts, such as Basic credentials. */
+export declare const PlacementBase64: Schema.Struct<{
+    readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
+        readonly field: Schema.NonEmptyString;
+    }>]>>;
+}>;
+export type PlacementBase64 = typeof PlacementBase64.Type;
+/** One part of a value template. Parts concatenate. */
+export declare const PlacementPart: Schema.Union<readonly [Schema.String, Schema.Struct<{
+    readonly field: Schema.NonEmptyString;
+}>, Schema.Struct<{
+    readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
+        readonly field: Schema.NonEmptyString;
+    }>]>>;
+}>]>;
+export type PlacementPart = typeof PlacementPart.Type;
+/** A lowercase HTTP header name (RFC 9110 token). */
+export declare const PlacementHeaderName: Schema.String;
+/**
+ * Where a credential may be sent and the exact value it is sent as. A header placement is the
+ * header's whole value; a query placement is the whole value of the named query parameter.
+ */
+export declare const Placement: Schema.Union<readonly [Schema.Struct<{
+    readonly in: Schema.Literal<"header">;
+    readonly name: Schema.String;
+    readonly value: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
+        readonly field: Schema.NonEmptyString;
+    }>, Schema.Struct<{
+        readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
+            readonly field: Schema.NonEmptyString;
+        }>]>>;
+    }>]>>;
+}>, Schema.Struct<{
+    readonly in: Schema.Literal<"query">;
+    readonly name: Schema.NonEmptyString;
+    readonly value: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
+        readonly field: Schema.NonEmptyString;
+    }>, Schema.Struct<{
+        readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
+            readonly field: Schema.NonEmptyString;
+        }>]>>;
+    }>]>>;
+}>]>;
+export type Placement = typeof Placement.Type;
+/** An auth method's placements. */
+export declare const Placements: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+    readonly in: Schema.Literal<"header">;
+    readonly name: Schema.String;
+    readonly value: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
+        readonly field: Schema.NonEmptyString;
+    }>, Schema.Struct<{
+        readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
+            readonly field: Schema.NonEmptyString;
+        }>]>>;
+    }>]>>;
+}>, Schema.Struct<{
+    readonly in: Schema.Literal<"query">;
+    readonly name: Schema.NonEmptyString;
+    readonly value: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
+        readonly field: Schema.NonEmptyString;
+    }>, Schema.Struct<{
+        readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
+            readonly field: Schema.NonEmptyString;
+        }>]>>;
+    }>]>>;
+}>]>>;
+/** Whether a part references a field. */
+export declare const isPlacementField: (part: PlacementPart) => part is PlacementField;
+/** The field names a template references, base64 parts included. */
+export declare const placementFields: (placement: Placement) => ReadonlySet<string>;
+/** Placements are equal when their JSON is: same location, name and template. */
+export declare const placementKey: (placement: Placement) => string;
+/** Placements in a stable order without repeats, so their order never changes an identity. */
+export declare const normalizePlacements: (placements: readonly Placement[]) => readonly Placement[];
+declare const PlacementFieldMissing_base: Schema.Class<PlacementFieldMissing, Schema.TaggedStruct<"PlacementFieldMissing", {
+    readonly field: Schema.String;
+}>, import("effect/Cause").YieldableError>;
+/** A field the template references has no string value. */
+export declare class PlacementFieldMissing extends PlacementFieldMissing_base {
+    get message(): string;
+}
+/** Render a template with field values. A referenced field without a string value fails. */
+export declare const renderPlacement: (placement: Placement, fields: Readonly<Record<string, unknown>>) => Result.Result<string, PlacementFieldMissing>;
+export {};

package/types/apps/src/contracts/protocol-version.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The host protocol this framework speaks. It is written into `runtime.json` and every host
+ * snapshot. Its schemas are `protocols/current.ts`; released protocols are frozen. See notes/apps-publishing.md.
+ * This file has no imports so the package build script can read it directly.
+ */
+export declare const frameworkProtocol = 13;