@ayni.org/ayni-agui-profile 0.0.0-stage → 3.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# @ayni.org/ayni-agui-profile
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+TypeScript types, constants and JSON schemas of the **Ayni AG-UI Profile 3.1**, the wire contract
+between an Ayni Agent (server) and an Ayni UI (client: the browser UI or the Ayni app). The normative
+text lives in `2060-io/ayni-spec`, `v4/ayni-agui-profile/profile.md`; this package follows it and cites
+its `PROF-*` identifiers. The package version tracks the profile version.
+
+The package carries no AG-UI runtime: it describes the Ayni-specific parts (descriptor, session
+endpoints, binding material, the session grant, `ayni.*` custom events, `forwardedProps.ayni` actions,
+`ayni.*` activity messages including the `ayni.flow` card, `state.ayni`, the app links of §10) and the
+few AG-UI message shapes it reuses.
+
+```ts
+import { APP_LINK_DOMAIN, buildAppLink, parseAppLink, PROFILE_VERSION } from '@ayni.org/ayni-agui-profile'
+
+buildAppLink(APP_LINK_DOMAIN.devnet, 'wallet', ['card', 'cred-1'])
+// https://app.dev.ayni.org/app/wallet/card/cred-1
+parseAppLink('https://app.dev.ayni.org/app/explore?q=notary&utm=x', APP_LINK_DOMAIN.devnet)
+// { route: 'explore', segments: [], params: { q: 'notary' } }
+```
+
+JSON schemas (draft 2020-12) are served under `schemas/`: `descriptor.schema.json`,
+`create-session.schema.json`, `ayni-action.schema.json`.
+
+Published to npm from this repository by the `npm-publish` workflow whenever `package.json` carries a
+version that is not on npm yet.

package/dist/index.d.ts

@@ -0,0 +1,523 @@
+/**
+ * Ayni AG-UI Profile 3.1 (2060-io/ayni-spec, v4/ayni-agui-profile/profile.md).
+ * Every name below cites the section or the PROF-* requirement it implements.
+ *
+ * 3.1 over 3.0: the session grant (`CreateSessionRequest.grant`, `features.sessionGrant`, §4.1), `features.flows`,
+ * `client.platform` as `web` | `ios` | `android` with `client.description` (PROF-SESS-014), the `ayni.flow` activity
+ * and `flowId` on routed capabilities (§5, §6, PROF-MAP-007), `metadata.flowId` (§8), the `grant-used` and
+ * `grant-expired` errors (§9), app links (§10, PROF-LINK-*). A 3.0 UI keeps working against a 3.1 agent.
+ */
+export declare const PROFILE_VERSION = "3.1";
+export declare const PROFILE_MAJOR = 3;
+export declare const PROFILE_MINOR = 1;
+/** DID Document service type that references the descriptor (PROF-DESC-001). */
+export declare const DID_SERVICE_TYPE = "AyniAgUI";
+/** Well-known path of the descriptor on the agent origin (PROF-DESC-001). */
+export declare const DESCRIPTOR_PATH = "/.well-known/ayni-agent.json";
+/**
+ * goal_code of the 3.0 binding invitation (profile section 4). Flow-capable wallets read the flow profile's codes
+ * below instead; agents keep emitting this one for wallets without flows.
+ */
+export declare const BINDING_GOAL_CODE = "ayni.bind-session";
+/** goal_code values of the flow profile §4 (FLOW-CONN-001): what follows the invitation. */
+export declare const INVITATION_GOAL_CODE: {
+    /** just connect */
+    readonly connect: "ayni.connect";
+    /** a web UI binding, confirmed by the `link-session` flow */
+    readonly linkSession: "ayni.link-session";
+    /** a service-initiated flow follows */
+    readonly flow: "ayni.flow";
+};
+export type InvitationGoalCode = (typeof INVITATION_GOAL_CODE)[keyof typeof INVITATION_GOAL_CODE];
+export interface UploadLimits {
+    maxBytes: number;
+    types: string[];
+}
+export interface DescriptorFeatures {
+    contextualMenu: boolean;
+    approvals: boolean;
+    reactions: boolean;
+    receipts: boolean;
+    history: boolean;
+    voiceNotes?: boolean;
+    uploads: UploadLimits | false;
+    /** the agent answers the `session-grant` flow (§4.1, PROF-DESC-004); absent on a 3.0 descriptor */
+    sessionGrant?: boolean;
+    /** the agent opens flows through the flow profile rather than question-answer and chat (PROF-DESC-004) */
+    flows?: boolean;
+}
+export type BindingMode = 'cross-device' | 'same-device';
+export interface AgentDescriptor {
+    profileVersion: string;
+    did: string;
+    name: string;
+    description?: string;
+    logo?: string;
+    sessions: string;
+    /**
+     * `walletLinkTemplate` is an HTTPS app link on the wallet app's domain with an `{oob}` placeholder, for the Ayni app
+     * `https://<app-link-domain>/app/connect?oob={oob}` (PROF-BIND-008); never a `didcomm://` URL.
+     */
+    binding: {
+        modes: BindingMode[];
+        walletLinkTemplate: string;
+    };
+    features: DescriptorFeatures;
+    locales: string[];
+}
+export type SessionState = 'provisional' | 'bound' | 'closed';
+/** Closure reasons (section 5, ayni.session.state). */
+export type ClosureReason = 'user' | 'supersede' | 'channel-closed' | 'credential-invalid' | 'idle-timeout' | 'expired' | 'agent';
+export declare const CLOSURE_REASONS: readonly ClosureReason[];
+/** The kind of device a client runs on (PROF-SESS-014). */
+export declare const CLIENT_PLATFORMS: readonly ["web", "ios", "android"];
+export type ClientPlatform = (typeof CLIENT_PLATFORMS)[number];
+export interface ClientDescription {
+    name: string;
+    version: string;
+    /**
+     * `web`, `ios` or `android` (PROF-SESS-014). A 3.0 client sent free text here ("Firefox on Linux"); a 3.1 agent
+     * records such a value as `description` and treats the platform as `web`.
+     */
+    platform: ClientPlatform | (string & {});
+    /** what the phone shows when it links this session: "Firefox on Linux", "Ayni on iPhone" (PROF-SESS-014) */
+    description?: string;
+}
+export declare function isClientPlatform(value: unknown): value is ClientPlatform;
+export interface CreateSessionRequest {
+    client: ClientDescription;
+    locale?: string;
+    /** handle of a device the agent bound before (PROF-BIND-009): the agent asks the phone to re-link it */
+    deviceHandle?: string;
+    /** the device secret handed with the handle (PROF-BIND-010): with it the session binds without the phone (PROF-SESS-010) */
+    deviceProof?: string;
+    /** a closed session of the same Principal to resume: its transcript stays readable in the new session (PROF-SESS-009) */
+    resumeSessionId?: string;
+    /** a conversation of the Principal to open on this device (PROF-CONV-005) */
+    conversationId?: string;
+    /** start a new conversation; without it and without a conversation named, the session continues the Principal's latest active one (PROF-CONV-006) */
+    newConversation?: boolean;
+    /** the single-use grant the `session-grant` flow returned (§4.1, PROF-SESS-013): the session is created bound */
+    grant?: string;
+}
+export interface BindingMaterial {
+    oobUrl: string;
+    walletLink: string;
+    bindingCode: string;
+    expiresAt: string;
+}
+export interface BackingIdentityDisplay {
+    kind: 'org' | 'persona';
+    name: string;
+}
+export interface PrincipalDisplay {
+    displayName: string;
+    /** attachment reference (id served by the attachments endpoint) or null */
+    photo: string | null;
+    backingIdentity: BackingIdentityDisplay | null;
+}
+export interface CreateSessionResponse {
+    sessionId: string;
+    sessionToken: string;
+    state: SessionState;
+    agent: {
+        did: string;
+        name: string;
+    };
+    /** absent on a sibling session (PROF-SESS-007) */
+    binding?: BindingMaterial;
+    /** present on a sibling session */
+    parentSessionId?: string;
+    principal?: PrincipalDisplay;
+    idleTimeoutSeconds: number;
+    /** 'asked' when the phone of the known device received the re-link question (PROF-BIND-009) */
+    rebind?: 'asked' | 'unavailable';
+    deviceHandle?: string;
+    /** the rotated device secret of a session bound from a proof, or minted at a phone binding (PROF-BIND-010) */
+    deviceSecret?: string;
+    /** why a presented proof was not accepted (PROF-SESS-010); the client discards its secret */
+    pairing?: 'expired' | 'invalid';
+    /** set when the resume was accepted (sibling) or recorded for binding (provisional) */
+    resumedFromSessionId?: string;
+    /** the conversation this session serves, once bound (PROF-CONV-005) */
+    conversationId?: string;
+}
+export interface SessionStatus {
+    sessionId: string;
+    state: SessionState;
+    reason?: ClosureReason;
+    principal: PrincipalDisplay | null;
+    boundAt?: string;
+    /** the device secret of a freshly bound session, until the client uses it (PROF-BIND-010) */
+    deviceSecret?: string;
+    /** the conversation this session serves, once bound */
+    conversationId?: string;
+    lastActivityAt: string;
+    idleTimeoutSeconds: number;
+    binding?: BindingMaterial;
+    parentSessionId?: string;
+    deviceHandle?: string;
+    resumedFromSessionId?: string;
+}
+export declare const CUSTOM_EVENT: {
+    readonly sessionState: "ayni.session.state";
+    readonly sessionBound: "ayni.session.bound";
+    readonly sessionToken: "ayni.session.token";
+    readonly capabilityRouted: "ayni.capability.routed";
+    readonly approvalRequest: "ayni.approval.request";
+    readonly approvalUpdate: "ayni.approval.update";
+    readonly reaction: "ayni.reaction";
+    readonly receipt: "ayni.receipt";
+};
+export type CustomEventName = (typeof CUSTOM_EVENT)[keyof typeof CUSTOM_EVENT];
+export type CapabilityKind = 'authentication' | 'credential-exchange' | 'auth-challenge' | 'authorization' | 'confirmation' | 'signature' | 'link-session';
+export type ChallengeType = 'device' | 'face-match' | 'document';
+export type CapabilityStatus = 'pending' | 'completed' | 'failed' | 'expired' | 'unavailable' | 'degraded';
+export interface SessionStateValue {
+    state: SessionState;
+    reason?: ClosureReason;
+}
+export interface SessionBoundValue {
+    principal: PrincipalDisplay;
+    boundAt: string;
+    /** opaque handle of this device, presented on later session creations to ask the phone for a re-link */
+    deviceHandle?: string;
+    /** the closed session this one resumes, when the agent accepted it */
+    resumedFromSessionId?: string;
+    /** the device secret minted at this binding (PROF-BIND-010) */
+    deviceSecret?: string;
+    conversationId?: string;
+}
+export interface SessionTokenValue {
+    sessionToken: string;
+}
+export interface CapabilityRoutedValue {
+    kind: CapabilityKind;
+    challengeType?: ChallengeType;
+    status: CapabilityStatus;
+    originSessionId: string;
+    expiresAt?: string;
+    /** operator wording for unavailable or degraded outcomes */
+    message?: string;
+    /** the flow profile's flow id when the capability is served as a flow (PROF-MAP-007) */
+    flowId?: string;
+}
+export type ApprovalStatus = 'PENDING' | 'APPROVED' | 'REJECTED' | 'CANCELLED' | 'EXPIRED';
+export type ApprovalKind = 'sensitivity' | 'elevation';
+export interface ApprovalPolicyDisplay {
+    type: 'count' | 'percentage';
+    value: number;
+    vetoOnRefusal?: boolean;
+}
+export interface ApprovalRequestValue {
+    approvalId: string;
+    kind: ApprovalKind;
+    tool: string;
+    requester: {
+        displayName: string;
+        role?: string;
+    };
+    purpose?: {
+        id: string;
+        label: string;
+    };
+    justification?: string;
+    policy: ApprovalPolicyDisplay;
+    expiresAt: string;
+    status?: ApprovalStatus;
+    /** true when the receiving Principal is the requester */
+    own?: boolean;
+    /** true when the receiving Principal may decide */
+    canDecide?: boolean;
+}
+export interface ApprovalUpdateValue {
+    approvalId: string;
+    status: ApprovalStatus;
+    decidedBy?: string;
+    grantExpiresAt?: string;
+}
+/**
+ * One reaction per person per message (PROF-ACT-003): an `add` replaces whatever the same `by`
+ * had on that message; a `remove` clears it.
+ */
+export interface ReactionValue {
+    messageId: string;
+    emoji: string;
+    action: 'add' | 'remove';
+    by: string;
+}
+/** `metadata` of a history or run message (PROF-HIST-006). */
+export interface MessageMetadata {
+    createdAt: string;
+    initiatedAt?: string;
+    sourceType?: string;
+    completion?: 'completed' | 'interrupted';
+    entryId?: string;
+    /** the id the client gave this message in the run that sent it, when it was the client's */
+    externalId?: string;
+    /** current reactions on the message, one per person */
+    reactions?: {
+        emoji: string;
+        by: string;
+    }[];
+    /** the message this one answers */
+    replyTo?: ReplyReference;
+    /** on an `ayni.flow` activity, the flow it records (section 8) */
+    flowId?: string;
+}
+export type ReceiptState = 'received' | 'viewed';
+export interface ReceiptValue {
+    messageIds: string[];
+    state: ReceiptState;
+}
+export interface CustomEventValueMap {
+    'ayni.session.state': SessionStateValue;
+    'ayni.session.bound': SessionBoundValue;
+    'ayni.session.token': SessionTokenValue;
+    'ayni.capability.routed': CapabilityRoutedValue;
+    'ayni.approval.request': ApprovalRequestValue;
+    'ayni.approval.update': ApprovalUpdateValue;
+    'ayni.reaction': ReactionValue;
+    'ayni.receipt': ReceiptValue;
+}
+export interface ContextualMenuItem {
+    id: string;
+    label: string;
+    description?: string;
+    badge?: number;
+    /** url items open a link instead of sending contextual.select */
+    url?: string;
+}
+export interface GeneratingEntry {
+    entryId: string;
+    kind: 'image';
+    startedAt: string;
+}
+export interface AyniState {
+    contextualMenu: {
+        items: ContextualMenuItem[];
+    };
+    pendingApprovals: number;
+    generating: GeneratingEntry[];
+    principal: PrincipalDisplay | null;
+    /** purposes a human may declare on an elevation request (PROF-RUN-005) */
+    purposes?: {
+        id: string;
+        label: string;
+        description?: string;
+    }[];
+}
+export interface AgUiState {
+    ayni: AyniState;
+}
+export type AyniActionKind = 'text' | 'menu.select' | 'contextual.select' | 'approval.decide' | 'approval.cancel' | 'elevation.request' | 'reaction' | 'receipt' | 'attachments';
+export declare const AYNI_ACTION_KINDS: readonly AyniActionKind[];
+/** A message the turn answers: the id of a transcript message of the same session (PROF-RUN-009). */
+export interface ReplyReference {
+    id: string;
+    /** short excerpt of the quoted message, for rendering */
+    text: string;
+    role: 'user' | 'assistant';
+}
+export type AyniAction = {
+    kind: 'text';
+    replyTo?: string;
+} | {
+    kind: 'menu.select';
+    menuId: string;
+    itemId: string;
+} | {
+    kind: 'contextual.select';
+    itemId: string;
+} | {
+    kind: 'approval.decide';
+    approvalId: string;
+    decision: 'approve' | 'reject';
+    note?: string;
+} | {
+    kind: 'approval.cancel';
+    approvalId: string;
+} | {
+    kind: 'elevation.request';
+    tool: string;
+    purposeId: string;
+    justification: string;
+} | {
+    kind: 'reaction';
+    messageId: string;
+    emoji: string;
+    action: 'add' | 'remove';
+} | {
+    kind: 'receipt';
+    messageIds: string[];
+    state: ReceiptState;
+} | {
+    kind: 'attachments';
+    attachmentIds: string[];
+    replyTo?: string;
+};
+export interface AyniForwardedProps {
+    ayni?: AyniAction;
+}
+/** Activity message types inside runs (section 6). */
+export declare const ACTIVITY: {
+    readonly menu: "ayni.menu";
+    readonly attachment: "ayni.attachment";
+    readonly approval: "ayni.approval";
+    readonly capability: "ayni.capability";
+    readonly flow: "ayni.flow";
+    readonly generating: "ayni.generating";
+};
+export type ActivityType = (typeof ACTIVITY)[keyof typeof ACTIVITY];
+export interface MenuActivity {
+    menuId: string;
+    prompt: string;
+    items: {
+        id: string;
+        label: string;
+        description?: string;
+    }[];
+    /** set once answered */
+    selectedItemId?: string;
+}
+export type AttachmentType = 'image' | 'voice' | 'video' | 'file';
+export interface AttachmentActivity {
+    attachmentId: string;
+    type: AttachmentType;
+    mimeType: string;
+    /** a short text stand-in: a caption, a transcription, a description; long extractions stay on the agent */
+    textRepr: string;
+    /** who sent it: the person (`user`) or the agent (`assistant`) */
+    role?: 'user' | 'assistant';
+    size?: number;
+    width?: number;
+    height?: number;
+    duration?: number;
+    filename?: string;
+    thumbnailId?: string;
+}
+export type ApprovalActivity = ApprovalRequestValue & {
+    status: ApprovalStatus;
+};
+export type CapabilityActivity = CapabilityRoutedValue;
+/** Lifecycle of a flow (flow profile §5.2). */
+export type FlowState = 'pending' | 'active' | 'completed' | 'declined' | 'cancelled' | 'failed' | 'expired';
+export type FlowOutcome = 'completed' | 'declined' | 'cancelled' | 'failed' | 'expired';
+export interface FlowReference {
+    type: string;
+    id: string;
+}
+/**
+ * The flow card (section 6, PROF-MAP-007; app spec §8.5): one per flow whose origin is a conversation, ordered at
+ * `openedAt`, replaced in place at close. `preview` holds only what the person received or disclosed, in a shape per
+ * kind that the agent pack may restrict.
+ */
+export interface FlowActivity {
+    flowId: string;
+    /** a kind of the flow profile §6: `present`, `issue`, `authorize`, `sign-tx`, `link-session`... */
+    kind: string;
+    state: FlowState;
+    title: string;
+    openedAt: string;
+    closedAt?: string;
+    outcome?: FlowOutcome;
+    references?: FlowReference[];
+    preview?: Record<string, unknown>;
+}
+export interface GeneratingActivity {
+    entryId: string;
+    kind: 'image';
+}
+/** Interrupt reasons the agent uses (PROF-RUN-006). */
+export declare const INTERRUPT_REASON: {
+    readonly menu: "ayni.menu";
+};
+/** RunError codes the agent uses (PROF-RUN-007). */
+export declare const RUN_ERROR_CODE: {
+    readonly cancelled: "cancelled";
+    readonly notBound: "not-bound";
+    readonly closed: "closed";
+    readonly internal: "internal";
+};
+/** A conversation of the Principal with this agent (section 3.6, PROF-CONV-001). */
+export type ConversationState = 'active' | 'archived';
+export interface ConversationInfo {
+    id: string;
+    title: string;
+    state: ConversationState;
+    createdAt: string;
+    lastActivityAt: string;
+    lastPreview?: string;
+    /** a session is open on it somewhere */
+    open: boolean;
+}
+export interface ConversationsResponse {
+    conversations: ConversationInfo[];
+}
+export interface ConversationPatch {
+    title?: string;
+    state?: ConversationState;
+}
+/** A paired device of the Principal (PROF-SESS-011). */
+export interface DeviceInfo {
+    handle: string;
+    client: ClientDescription;
+    createdAt: string;
+    lastUsedAt: string;
+    /** the caller's own device */
+    current: boolean;
+}
+export interface DevicesResponse {
+    devices: DeviceInfo[];
+}
+export interface HistoryPage {
+    messages: unknown[];
+    nextBefore: string | null;
+}
+export interface UploadResponse {
+    attachmentId: string;
+    type: AttachmentType;
+    mimeType: string;
+    size: number;
+}
+export type ErrorCode = 'unauthorized' | 'not-bound' | 'not-found' | 'conflict' | 'closed' | 'too-large' | 'rate-limited' | 'bad-request'
+/** `POST {sessions}` with a grant already used (§3.2, PROF-SESS-013) */
+ | 'grant-used'
+/** `POST {sessions}` with a grant past its sixty seconds */
+ | 'grant-expired';
+export interface ErrorBody {
+    error: ErrorCode | string;
+    reason?: ClosureReason;
+    message?: string;
+    binding?: BindingMaterial;
+}
+/** Binding code format: two letters, a dash, two letters or digits, derived from the nonce (section 3.2). */
+export declare const BINDING_CODE_PATTERN: RegExp;
+/** The app-link domain of each network (section 10; app spec D39): the hosts of the web UI. */
+export declare const APP_LINK_DOMAIN: {
+    readonly devnet: "app.dev.ayni.org";
+    readonly testnet: "app.test.ayni.org";
+    readonly mainnet: "app.ayni.org";
+};
+export type AppLinkNetwork = keyof typeof APP_LINK_DOMAIN;
+/** The first path segment after `/app/` of every destination of section 10. */
+export declare const APP_LINK_ROUTES: readonly ["home", "recent", "scan", "explore", "wallet", "service", "settings", "connect"];
+export type AppLinkRoute = (typeof APP_LINK_ROUTES)[number];
+/** The only query parameters a link may carry (PROF-LINK-003); a UI ignores any other. */
+export declare const APP_LINK_PARAMS: readonly ["q", "to", "amount", "memo", "oob"];
+export type AppLinkParam = (typeof APP_LINK_PARAMS)[number];
+export interface AppLink {
+    route: AppLinkRoute;
+    /** the path segments after the route: a controller key, `documents`, `card` and an id, a DID, `backup`... */
+    segments: string[];
+    params: Partial<Record<AppLinkParam, string>>;
+}
+/** Builds an HTTPS app link of section 10 on the given app-link domain (PROF-LINK-001). */
+export declare function buildAppLink(domain: string, route: AppLinkRoute, segments?: string[], params?: Partial<Record<AppLinkParam, string>>): string;
+/**
+ * Reads an app link (PROF-LINK-002): null when the URL is not HTTPS on the app-link domain, or not an `/app/<route>`
+ * path of section 10. Parameters outside PROF-LINK-003 are dropped. Links navigate, never act.
+ */
+export declare function parseAppLink(url: string, domain: string): AppLink | null;
+/** Whether a URL is a link on the app-link domain, whatever its path. */
+export declare function isAppLink(url: string, domain: string): boolean;

package/dist/index.js

@@ -0,0 +1,153 @@
+/**
+ * Ayni AG-UI Profile 3.1 (2060-io/ayni-spec, v4/ayni-agui-profile/profile.md).
+ * Every name below cites the section or the PROF-* requirement it implements.
+ *
+ * 3.1 over 3.0: the session grant (`CreateSessionRequest.grant`, `features.sessionGrant`, §4.1), `features.flows`,
+ * `client.platform` as `web` | `ios` | `android` with `client.description` (PROF-SESS-014), the `ayni.flow` activity
+ * and `flowId` on routed capabilities (§5, §6, PROF-MAP-007), `metadata.flowId` (§8), the `grant-used` and
+ * `grant-expired` errors (§9), app links (§10, PROF-LINK-*). A 3.0 UI keeps working against a 3.1 agent.
+ */
+export const PROFILE_VERSION = '3.1';
+export const PROFILE_MAJOR = 3;
+export const PROFILE_MINOR = 1;
+/** DID Document service type that references the descriptor (PROF-DESC-001). */
+export const DID_SERVICE_TYPE = 'AyniAgUI';
+/** Well-known path of the descriptor on the agent origin (PROF-DESC-001). */
+export const DESCRIPTOR_PATH = '/.well-known/ayni-agent.json';
+/**
+ * goal_code of the 3.0 binding invitation (profile section 4). Flow-capable wallets read the flow profile's codes
+ * below instead; agents keep emitting this one for wallets without flows.
+ */
+export const BINDING_GOAL_CODE = 'ayni.bind-session';
+/** goal_code values of the flow profile §4 (FLOW-CONN-001): what follows the invitation. */
+export const INVITATION_GOAL_CODE = {
+    /** just connect */
+    connect: 'ayni.connect',
+    /** a web UI binding, confirmed by the `link-session` flow */
+    linkSession: 'ayni.link-session',
+    /** a service-initiated flow follows */
+    flow: 'ayni.flow',
+};
+export const CLOSURE_REASONS = [
+    'user',
+    'supersede',
+    'channel-closed',
+    'credential-invalid',
+    'idle-timeout',
+    'expired',
+    'agent',
+];
+/** The kind of device a client runs on (PROF-SESS-014). */
+export const CLIENT_PLATFORMS = ['web', 'ios', 'android'];
+export function isClientPlatform(value) {
+    return typeof value === 'string' && CLIENT_PLATFORMS.includes(value);
+}
+// ---------------------------------------------------------------------------------------------
+// Custom events on the session stream (section 5)
+export const CUSTOM_EVENT = {
+    sessionState: 'ayni.session.state',
+    sessionBound: 'ayni.session.bound',
+    sessionToken: 'ayni.session.token',
+    capabilityRouted: 'ayni.capability.routed',
+    approvalRequest: 'ayni.approval.request',
+    approvalUpdate: 'ayni.approval.update',
+    reaction: 'ayni.reaction',
+    receipt: 'ayni.receipt',
+};
+export const AYNI_ACTION_KINDS = [
+    'text',
+    'menu.select',
+    'contextual.select',
+    'approval.decide',
+    'approval.cancel',
+    'elevation.request',
+    'reaction',
+    'receipt',
+    'attachments',
+];
+/** Activity message types inside runs (section 6). */
+export const ACTIVITY = {
+    menu: 'ayni.menu',
+    attachment: 'ayni.attachment',
+    approval: 'ayni.approval',
+    capability: 'ayni.capability',
+    flow: 'ayni.flow',
+    generating: 'ayni.generating',
+};
+/** Interrupt reasons the agent uses (PROF-RUN-006). */
+export const INTERRUPT_REASON = {
+    menu: 'ayni.menu',
+};
+/** RunError codes the agent uses (PROF-RUN-007). */
+export const RUN_ERROR_CODE = {
+    cancelled: 'cancelled',
+    notBound: 'not-bound',
+    closed: 'closed',
+    internal: 'internal',
+};
+/** Binding code format: two letters, a dash, two letters or digits, derived from the nonce (section 3.2). */
+export const BINDING_CODE_PATTERN = /^[A-Z0-9]{2}-[A-Z0-9]{2}$/;
+// ---------------------------------------------------------------------------------------------
+// App links (section 10, PROF-LINK-001..003)
+/** The app-link domain of each network (section 10; app spec D39): the hosts of the web UI. */
+export const APP_LINK_DOMAIN = {
+    devnet: 'app.dev.ayni.org',
+    testnet: 'app.test.ayni.org',
+    mainnet: 'app.ayni.org',
+};
+/** The first path segment after `/app/` of every destination of section 10. */
+export const APP_LINK_ROUTES = [
+    'home',
+    'recent',
+    'scan',
+    'explore',
+    'wallet',
+    'service',
+    'settings',
+    'connect',
+];
+/** The only query parameters a link may carry (PROF-LINK-003); a UI ignores any other. */
+export const APP_LINK_PARAMS = ['q', 'to', 'amount', 'memo', 'oob'];
+/** Builds an HTTPS app link of section 10 on the given app-link domain (PROF-LINK-001). */
+export function buildAppLink(domain, route, segments = [], params = {}) {
+    const path = ['app', route, ...segments.map((segment) => encodeURIComponent(segment))].join('/');
+    const url = new URL(`https://${domain}/${path}`);
+    for (const key of APP_LINK_PARAMS) {
+        const value = params[key];
+        if (value !== undefined)
+            url.searchParams.set(key, value);
+    }
+    return url.toString();
+}
+/**
+ * Reads an app link (PROF-LINK-002): null when the URL is not HTTPS on the app-link domain, or not an `/app/<route>`
+ * path of section 10. Parameters outside PROF-LINK-003 are dropped. Links navigate, never act.
+ */
+export function parseAppLink(url, domain) {
+    let parsed;
+    try {
+        parsed = new URL(url);
+    }
+    catch {
+        return null;
+    }
+    if (parsed.protocol !== 'https:' || parsed.host.toLowerCase() !== domain.toLowerCase())
+        return null;
+    const segments = parsed.pathname.split('/').filter(Boolean).map(decodeURIComponent);
+    if (segments.length < 2 || segments[0] !== 'app')
+        return null;
+    const route = segments[1];
+    if (!APP_LINK_ROUTES.includes(route))
+        return null;
+    const params = {};
+    for (const key of APP_LINK_PARAMS) {
+        const value = parsed.searchParams.get(key);
+        if (value !== null)
+            params[key] = value;
+    }
+    return { route: route, segments: segments.slice(2), params };
+}
+/** Whether a URL is a link on the app-link domain, whatever its path. */
+export function isAppLink(url, domain) {
+    return parseAppLink(url, domain) !== null;
+}

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@ayni.org/ayni-agui-profile",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "3.1.1",
+  "description": "Ayni AG-UI Profile 3.1: the wire contract between an Ayni Agent and an Ayni UI (types, constants, JSON schemas, app links)",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./schemas/*": "./schemas/*"
+  },
+  "files": [
+    "dist",
+    "schemas",
+    "README.md"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/2060-io/ayni-agent",
+    "directory": "packages/agui-profile"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "homepage": "https://github.com/2060-io/ayni-agent/tree/main/packages/agui-profile",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "ayni",
+    "ag-ui",
+    "didcomm",
+    "verifiable-trust"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check-types": "tsc -p tsconfig.json --noEmit"
+  }
 }

package/schemas/ayni-action.schema.json

@@ -0,0 +1,152 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://2060.io/schemas/ayni-agui-profile/3.1/ayni-action.json",
+  "title": "forwardedProps.ayni (profile section 6, PROF-RUN-003)",
+  "type": "object",
+  "required": ["kind"],
+  "oneOf": [
+    {
+      "properties": {
+        "kind": {
+          "const": "text"
+        },
+        "replyTo": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "properties": {
+        "kind": {
+          "const": "menu.select"
+        },
+        "menuId": {
+          "type": "string"
+        },
+        "itemId": {
+          "type": "string"
+        }
+      },
+      "required": ["kind", "menuId", "itemId"],
+      "additionalProperties": false
+    },
+    {
+      "properties": {
+        "kind": {
+          "const": "contextual.select"
+        },
+        "itemId": {
+          "type": "string"
+        }
+      },
+      "required": ["kind", "itemId"],
+      "additionalProperties": false
+    },
+    {
+      "properties": {
+        "kind": {
+          "const": "approval.decide"
+        },
+        "approvalId": {
+          "type": "string"
+        },
+        "decision": {
+          "enum": ["approve", "reject"]
+        },
+        "note": {
+          "type": "string"
+        }
+      },
+      "required": ["kind", "approvalId", "decision"],
+      "additionalProperties": false
+    },
+    {
+      "properties": {
+        "kind": {
+          "const": "approval.cancel"
+        },
+        "approvalId": {
+          "type": "string"
+        }
+      },
+      "required": ["kind", "approvalId"],
+      "additionalProperties": false
+    },
+    {
+      "properties": {
+        "kind": {
+          "const": "elevation.request"
+        },
+        "tool": {
+          "type": "string"
+        },
+        "purposeId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "justification": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": ["kind", "tool", "purposeId", "justification"],
+      "additionalProperties": false
+    },
+    {
+      "properties": {
+        "kind": {
+          "const": "reaction"
+        },
+        "messageId": {
+          "type": "string"
+        },
+        "emoji": {
+          "type": "string"
+        },
+        "action": {
+          "enum": ["add", "remove"]
+        }
+      },
+      "required": ["kind", "messageId", "emoji", "action"],
+      "additionalProperties": false
+    },
+    {
+      "properties": {
+        "kind": {
+          "const": "receipt"
+        },
+        "messageIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "state": {
+          "enum": ["received", "viewed"]
+        }
+      },
+      "required": ["kind", "messageIds", "state"],
+      "additionalProperties": false
+    },
+    {
+      "properties": {
+        "kind": {
+          "const": "attachments"
+        },
+        "attachmentIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
+        },
+        "replyTo": {
+          "type": "string"
+        }
+      },
+      "required": ["kind", "attachmentIds"],
+      "additionalProperties": false
+    }
+  ]
+}

package/schemas/create-session.schema.json

@@ -0,0 +1,62 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://2060.io/schemas/ayni-agui-profile/3.1/create-session.json",
+  "title": "POST {sessions} body (profile section 3.2, PROF-SESS-013, PROF-SESS-014)",
+  "type": "object",
+  "required": ["client"],
+  "properties": {
+    "client": {
+      "type": "object",
+      "required": ["name", "version", "platform"],
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 80
+        },
+        "version": {
+          "type": "string",
+          "maxLength": 40
+        },
+        "platform": {
+          "type": "string",
+          "maxLength": 80,
+          "description": "web, ios or android (PROF-SESS-014); a 3.0 client sent free text, which a 3.1 agent records as description and treats as web"
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 120,
+          "description": "what the phone shows when it links this session (PROF-SESS-014)"
+        }
+      }
+    },
+    "locale": {
+      "type": "string",
+      "maxLength": 20
+    },
+    "deviceHandle": {
+      "type": "string",
+      "maxLength": 128
+    },
+    "resumeSessionId": {
+      "type": "string",
+      "maxLength": 128
+    },
+    "deviceProof": {
+      "type": "string",
+      "maxLength": 128
+    },
+    "conversationId": {
+      "type": "string",
+      "maxLength": 128
+    },
+    "newConversation": {
+      "type": "boolean"
+    },
+    "grant": {
+      "type": "string",
+      "maxLength": 256,
+      "description": "the single-use grant the session-grant flow returned (section 4.1, PROF-SESS-013)"
+    }
+  }
+}

package/schemas/descriptor.schema.json

@@ -0,0 +1,108 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://2060.io/schemas/ayni-agui-profile/3.1/descriptor.json",
+  "title": "Ayni agent descriptor (profile section 2, PROF-DESC-002)",
+  "type": "object",
+  "required": ["profileVersion", "did", "name", "sessions", "binding", "features"],
+  "properties": {
+    "profileVersion": {
+      "type": "string",
+      "pattern": "^3\\.[0-9]+$"
+    },
+    "did": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:.+$"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "description": {
+      "type": "string"
+    },
+    "logo": {
+      "type": "string",
+      "format": "uri"
+    },
+    "sessions": {
+      "type": "string",
+      "format": "uri"
+    },
+    "binding": {
+      "type": "object",
+      "required": ["modes", "walletLinkTemplate"],
+      "properties": {
+        "modes": {
+          "type": "array",
+          "items": {
+            "enum": ["cross-device", "same-device"]
+          }
+        },
+        "walletLinkTemplate": {
+          "type": "string",
+          "pattern": "^https://.*\\{oob\\}.*$"
+        }
+      }
+    },
+    "features": {
+      "type": "object",
+      "required": ["contextualMenu", "approvals", "reactions", "receipts", "history", "uploads"],
+      "properties": {
+        "contextualMenu": {
+          "type": "boolean"
+        },
+        "approvals": {
+          "type": "boolean"
+        },
+        "reactions": {
+          "type": "boolean"
+        },
+        "receipts": {
+          "type": "boolean"
+        },
+        "history": {
+          "type": "boolean"
+        },
+        "voiceNotes": {
+          "type": "boolean"
+        },
+        "uploads": {
+          "oneOf": [
+            {
+              "const": false
+            },
+            {
+              "type": "object",
+              "required": ["maxBytes", "types"],
+              "properties": {
+                "maxBytes": {
+                  "type": "integer"
+                },
+                "types": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          ]
+        },
+        "sessionGrant": {
+          "type": "boolean",
+          "description": "the agent answers the session-grant flow (section 4.1, PROF-DESC-004)"
+        },
+        "flows": {
+          "type": "boolean",
+          "description": "the agent opens flows through the flow profile (PROF-DESC-004)"
+        }
+      }
+    },
+    "locales": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  }
+}