@ayni.org/vs-agent-plugin-ayni-flow 0.0.0-stage → 0.1.2

package/build/nestjs/dto/common.dto.js

@@ -0,0 +1,107 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { IsISO8601, IsNotEmpty, IsOptional, IsString } from 'class-validator';
+export class SentMessageDto {
+}
+__decorate([
+    ApiProperty({ description: 'Identifier of the sent message', example: 'a1b2c3d4-5678-90ab-cdef-1234567890ab' }),
+    __metadata("design:type", String)
+], SentMessageDto.prototype, "id", void 0);
+/** Fields every carrier `request` body shares. */
+export class CarrierRequestBaseDto {
+}
+__decorate([
+    ApiProperty({ description: 'Connection to send the request on', example: 'conn-1234-5678' }),
+    IsString(),
+    IsNotEmpty(),
+    __metadata("design:type", String)
+], CarrierRequestBaseDto.prototype, "connectionId", void 0);
+__decorate([
+    ApiPropertyOptional({
+        description: 'The flow the request runs inside (the id of the ayni-flow open), set as ~thread.pthid',
+        example: 'f1ow-7c2e',
+    }),
+    IsOptional(),
+    IsString(),
+    __metadata("design:type", String)
+], CarrierRequestBaseDto.prototype, "flowId", void 0);
+export class AttestationDto {
+}
+__decorate([
+    ApiProperty({ enum: ['biometric', 'passcode', 'none'] }),
+    IsString(),
+    __metadata("design:type", String)
+], AttestationDto.prototype, "method", void 0);
+__decorate([
+    ApiProperty({ description: 'When the person authenticated, ISO 8601', example: '2026-10-24T15:21:03Z' }),
+    IsISO8601(),
+    __metadata("design:type", String)
+], AttestationDto.prototype, "at", void 0);
+/** One carrier exchange as the Admin API returns it and as the webhook events carry it. */
+export class CarrierExchangeDto {
+}
+__decorate([
+    ApiProperty({ description: 'The request id, thread of the exchange' }),
+    __metadata("design:type", String)
+], CarrierExchangeDto.prototype, "threadId", void 0);
+__decorate([
+    ApiPropertyOptional({ description: 'The flow id when the exchange runs inside an ayni-flow' }),
+    __metadata("design:type", String)
+], CarrierExchangeDto.prototype, "flowId", void 0);
+__decorate([
+    ApiProperty(),
+    __metadata("design:type", String)
+], CarrierExchangeDto.prototype, "connectionId", void 0);
+__decorate([
+    ApiProperty({ description: 'The role this agent plays in the exchange' }),
+    __metadata("design:type", String)
+], CarrierExchangeDto.prototype, "role", void 0);
+__decorate([
+    ApiProperty({
+        description: 'request-sent | request-received | response-sent | response-received | answered | failed',
+    }),
+    __metadata("design:type", String)
+], CarrierExchangeDto.prototype, "state", void 0);
+__decorate([
+    ApiProperty({ description: 'The request body as sent or received' }),
+    __metadata("design:type", Object)
+], CarrierExchangeDto.prototype, "request", void 0);
+__decorate([
+    ApiPropertyOptional({ description: 'The response body as sent or received' }),
+    __metadata("design:type", Object)
+], CarrierExchangeDto.prototype, "response", void 0);
+__decorate([
+    ApiPropertyOptional({ description: 'With state failed: why (malformed, declined, ...)' }),
+    __metadata("design:type", String)
+], CarrierExchangeDto.prototype, "errorCode", void 0);
+__decorate([
+    ApiPropertyOptional(),
+    __metadata("design:type", String)
+], CarrierExchangeDto.prototype, "errorDescription", void 0);
+__decorate([
+    ApiProperty(),
+    __metadata("design:type", String)
+], CarrierExchangeDto.prototype, "createdAt", void 0);
+export function toCarrierExchangeDto(record) {
+    return {
+        threadId: record.threadId,
+        flowId: record.parentThreadId,
+        connectionId: record.connectionId,
+        role: record.role,
+        state: record.state,
+        request: record.request,
+        response: record.response,
+        errorCode: record.errorCode,
+        errorDescription: record.errorDescription,
+        createdAt: record.createdAt.toISOString(),
+    };
+}
+//# sourceMappingURL=common.dto.js.map

package/build/nestjs/dto/common.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.dto.js","sourceRoot":"","sources":["../../../src/nestjs/dto/common.dto.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAClE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAE7E,MAAM,OAAO,cAAc;CAG1B;AADC;IADC,WAAW,CAAC,EAAE,WAAW,EAAE,gCAAgC,EAAE,OAAO,EAAE,sCAAsC,EAAE,CAAC;;0CACrG;AAGb,kDAAkD;AAClD,MAAM,OAAO,qBAAqB;CAajC;AATC;IAHC,WAAW,CAAC,EAAE,WAAW,EAAE,mCAAmC,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5F,QAAQ,EAAE;IACV,UAAU,EAAE;;2DACQ;AAQrB;IANC,mBAAmB,CAAC;QACnB,WAAW,EAAE,uFAAuF;QACpG,OAAO,EAAE,WAAW;KACrB,CAAC;IACD,UAAU,EAAE;IACZ,QAAQ,EAAE;;qDACI;AAGjB,MAAM,OAAO,cAAc;CAQ1B;AALC;IAFC,WAAW,CAAC,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,CAAC;IACxD,QAAQ,EAAE;;8CAC+B;AAI1C;IAFC,WAAW,CAAC,EAAE,WAAW,EAAE,yCAAyC,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC;IACxG,SAAS,EAAE;;0CACD;AAGb,2FAA2F;AAC3F,MAAM,OAAO,kBAAkB;CAgC9B;AA9BC;IADC,WAAW,CAAC,EAAE,WAAW,EAAE,wCAAwC,EAAE,CAAC;;oDACtD;AAGjB;IADC,mBAAmB,CAAC,EAAE,WAAW,EAAE,wDAAwD,EAAE,CAAC;;kDAChF;AAGf;IADC,WAAW,EAAE;;wDACO;AAGrB;IADC,WAAW,CAAC,EAAE,WAAW,EAAE,2CAA2C,EAAE,CAAC;;gDAC7D;AAKb;IAHC,WAAW,CAAC;QACX,WAAW,EAAE,yFAAyF;KACvG,CAAC;;iDACY;AAGd;IADC,WAAW,CAAC,EAAE,WAAW,EAAE,sCAAsC,EAAE,CAAC;;mDACpC;AAGjC;IADC,mBAAmB,CAAC,EAAE,WAAW,EAAE,uCAAuC,EAAE,CAAC;;oDAC5C;AAGlC;IADC,mBAAmB,CAAC,EAAE,WAAW,EAAE,mDAAmD,EAAE,CAAC;;qDACxE;AAGlB;IADC,mBAAmB,EAAE;;4DACG;AAGzB;IADC,WAAW,EAAE;;qDACI;AAgBpB,MAAM,UAAU,oBAAoB,CAAC,MAAyB;IAC5D,OAAO;QACL,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,MAAM,EAAE,MAAM,CAAC,cAAc;QAC7B,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,OAAO,EAAE,MAAM,CAAC,OAAkC;QAClD,QAAQ,EAAE,MAAM,CAAC,QAA+C;QAChE,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,WAAW,EAAE;KAC1C,CAAA;AACH,CAAC"}

package/build/nestjs/dto/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ayni-flow.dto.js';
+export * from './carriers.dto.js';
+export * from './common.dto.js';

package/build/nestjs/dto/index.js

@@ -0,0 +1,4 @@
+export * from './ayni-flow.dto.js';
+export * from './carriers.dto.js';
+export * from './common.dto.js';
+//# sourceMappingURL=index.js.map

package/build/nestjs/dto/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/nestjs/dto/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA"}

package/build/sdk/setupAyniFlowProtocols.d.ts

@@ -0,0 +1,10 @@
+import type { AyniFlowModules, AyniFlowPluginOptions } from '../types.js';
+export interface AyniFlowSdkPlugin {
+    modules: AyniFlowModules;
+}
+/**
+ * The Credo modules of the Ayni Flow Profile 1.0 with the roles of its §3 for one side: a service discloses
+ * `requester` (authorize, confirm, sign-tx), `agent` (link-session, session-grant), `sender` (notify), `issuer`
+ * (reissue) and `service` (ayni-flow); a holder the opposite roles. Must be used together with `setupBaseDidComm()`.
+ */
+export declare function setupAyniFlowProtocols(options?: AyniFlowPluginOptions): AyniFlowSdkPlugin;

package/build/sdk/setupAyniFlowProtocols.js

@@ -0,0 +1,36 @@
+import { AuthorizeModule, AuthorizeRole } from '@ayni.org/credo-ts-didcomm-authorize';
+import { AyniFlowModule, AyniFlowRole } from '@ayni.org/credo-ts-didcomm-ayni-flow';
+import { ConfirmModule, ConfirmRole } from '@ayni.org/credo-ts-didcomm-confirm';
+import { LinkSessionModule, LinkSessionRole } from '@ayni.org/credo-ts-didcomm-link-session';
+import { NotifyModule, NotifyRole } from '@ayni.org/credo-ts-didcomm-notify';
+import { ReissueModule, ReissueRole } from '@ayni.org/credo-ts-didcomm-reissue';
+import { SessionGrantModule, SessionGrantRole } from '@ayni.org/credo-ts-didcomm-session-grant';
+import { SignTxModule, SignTxRole } from '@ayni.org/credo-ts-didcomm-sign-tx';
+/**
+ * The Credo modules of the Ayni Flow Profile 1.0 with the roles of its §3 for one side: a service discloses
+ * `requester` (authorize, confirm, sign-tx), `agent` (link-session, session-grant), `sender` (notify), `issuer`
+ * (reissue) and `service` (ayni-flow); a holder the opposite roles. Must be used together with `setupBaseDidComm()`.
+ */
+export function setupAyniFlowProtocols(options = {}) {
+    const service = (options.side ?? 'service') === 'service';
+    return {
+        modules: {
+            ayniFlow: new AyniFlowModule({
+                role: service ? AyniFlowRole.Service : AyniFlowRole.Holder,
+                supportedKinds: options.supportedKinds,
+                maxPendingFlows: options.maxPendingFlows,
+                expiryCheckIntervalMs: options.expiryCheckIntervalMs ?? (service ? 60000 : 0),
+            }),
+            authorize: new AuthorizeModule({ roles: [service ? AuthorizeRole.Requester : AuthorizeRole.Approver] }),
+            confirm: new ConfirmModule({ roles: [service ? ConfirmRole.Requester : ConfirmRole.Confirmer] }),
+            linkSession: new LinkSessionModule({ roles: [service ? LinkSessionRole.Agent : LinkSessionRole.Holder] }),
+            sessionGrant: new SessionGrantModule({
+                roles: [service ? SessionGrantRole.Agent : SessionGrantRole.Requester],
+            }),
+            signTx: new SignTxModule({ roles: [service ? SignTxRole.Requester : SignTxRole.Signer] }),
+            notify: new NotifyModule({ roles: [service ? NotifyRole.Sender : NotifyRole.Receiver] }),
+            reissue: new ReissueModule({ roles: [service ? ReissueRole.Issuer : ReissueRole.Requester] }),
+        },
+    };
+}
+//# sourceMappingURL=setupAyniFlowProtocols.js.map

package/build/sdk/setupAyniFlowProtocols.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupAyniFlowProtocols.js","sourceRoot":"","sources":["../../src/sdk/setupAyniFlowProtocols.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAA;AACrF,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAA;AACnF,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAA;AAC/E,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAA;AAC5F,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAC5E,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAA;AAC/E,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAA;AAC/F,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAA;AAQ7E;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,UAAiC,EAAE;IACxE,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,SAAS,CAAC,KAAK,SAAS,CAAA;IACzD,OAAO;QACL,OAAO,EAAE;YACP,QAAQ,EAAE,IAAI,cAAc,CAAC;gBAC3B,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM;gBAC1D,cAAc,EAAE,OAAO,CAAC,cAAc;gBACtC,eAAe,EAAE,OAAO,CAAC,eAAe;gBACxC,qBAAqB,EAAE,OAAO,CAAC,qBAAqB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,CAAC;aAC/E,CAAC;YACF,SAAS,EAAE,IAAI,eAAe,CAAC,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvG,OAAO,EAAE,IAAI,aAAa,CAAC,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;YAChG,WAAW,EAAE,IAAI,iBAAiB,CAAC,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;YACzG,YAAY,EAAE,IAAI,kBAAkB,CAAC;gBACnC,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,gBAAgB,CAAC,SAAS,CAAC;aACvE,CAAC;YACF,MAAM,EAAE,IAAI,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YACzF,MAAM,EAAE,IAAI,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxF,OAAO,EAAE,IAAI,aAAa,CAAC,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;SAC9F;KACF,CAAA;AACH,CAAC"}

package/build/types.d.ts

@@ -0,0 +1,33 @@
+import type { AuthorizeModule } from '@ayni.org/credo-ts-didcomm-authorize';
+import type { AyniFlowModule } from '@ayni.org/credo-ts-didcomm-ayni-flow';
+import type { ConfirmModule } from '@ayni.org/credo-ts-didcomm-confirm';
+import type { LinkSessionModule } from '@ayni.org/credo-ts-didcomm-link-session';
+import type { NotifyModule } from '@ayni.org/credo-ts-didcomm-notify';
+import type { ReissueModule } from '@ayni.org/credo-ts-didcomm-reissue';
+import type { SessionGrantModule } from '@ayni.org/credo-ts-didcomm-session-grant';
+import type { SignTxModule } from '@ayni.org/credo-ts-didcomm-sign-tx';
+import type { BaseAgentModules } from '@verana-labs/vs-agent-sdk';
+/** The Credo modules this plugin adds to a VS Agent, by the names the Admin API controllers resolve them under. */
+export type AyniFlowModules = {
+    ayniFlow: AyniFlowModule;
+    authorize: AuthorizeModule;
+    confirm: ConfirmModule;
+    linkSession: LinkSessionModule;
+    sessionGrant: SessionGrantModule;
+    signTx: SignTxModule;
+    notify: NotifyModule;
+    reissue: ReissueModule;
+};
+export type AyniFlowAgentModules = BaseAgentModules & AyniFlowModules;
+/** The side of the flow profile this VS Agent plays (§1): a Verifiable Service, or a holder for tests and tooling. */
+export type AyniFlowSide = 'service' | 'holder';
+export interface AyniFlowPluginOptions {
+    /** Defaults to `service`: a Verifiable Service that opens flows for the Ayni app. */
+    side?: AyniFlowSide;
+    /** Kinds this agent accepts in an `open`; defaults per side (see `AyniFlowModuleConfigOptions.supportedKinds`). */
+    supportedKinds?: string[];
+    /** Pending flows per connection beyond which an `open` is refused; defaults per side. */
+    maxPendingFlows?: number;
+    /** Interval of the local expiry sweep in milliseconds; defaults to 60 000 on a service, 0 (off) on a holder. */
+    expiryCheckIntervalMs?: number;
+}

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,61 @@
 {
   "name": "@ayni.org/vs-agent-plugin-ayni-flow",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "0.1.2",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "default": "./build/index.js"
+    }
+  },
+  "files": [
+    "build"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "Apache-2.0",
+  "description": "VS Agent plugin for the Ayni Flow Profile 1.0: the ayni-flow envelope and its seven carrier protocols as Credo modules, Admin API v2 routes and webhook events (CC-VSA-005, CC-VSA-007, CC-VSA-010)",
+  "homepage": "https://github.com/2060-io/credo-ts-ayni-flow/tree/main/packages/vs-agent-plugin",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/2060-io/credo-ts-ayni-flow",
+    "directory": "packages/vs-agent-plugin"
+  },
+  "dependencies": {
+    "@ayni.org/credo-ts-didcomm-authorize": "^0.1.2",
+    "@ayni.org/credo-ts-didcomm-ayni-flow": "^0.1.2",
+    "@ayni.org/credo-ts-didcomm-confirm": "^0.1.2",
+    "@ayni.org/credo-ts-didcomm-link-session": "^0.1.2",
+    "@ayni.org/credo-ts-didcomm-notify": "^0.1.2",
+    "@ayni.org/credo-ts-didcomm-reissue": "^0.1.2",
+    "@ayni.org/credo-ts-didcomm-session-grant": "^0.1.2",
+    "@ayni.org/credo-ts-didcomm-sign-tx": "^0.1.2"
+  },
+  "peerDependencies": {
+    "@credo-ts/core": ">=0.8.0-pr-2704-20261026000000 <0.9.0",
+    "@credo-ts/didcomm": ">=0.8.0-pr-2704-20261026000000 <0.9.0",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/swagger": "^8.0.0",
+    "@verana-labs/vs-agent-sdk": ">=2.0.0-dev.100",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.0"
+  },
+  "devDependencies": {
+    "@credo-ts/core": "0.8.0-pr-2704-20261029165313",
+    "@credo-ts/didcomm": "0.8.0-pr-2704-20261029165313",
+    "@nestjs/common": "^10.4.0",
+    "@nestjs/swagger": "^8.1.0",
+    "@verana-labs/vs-agent-sdk": "2.0.0-dev.102",
+    "reflect-metadata": "^0.2.2",
+    "class-transformer": "0.5.1",
+    "class-validator": "^0.14.3"
+  },
+  "scripts": {
+    "build": "rimraf ./build && tsc -p tsconfig.build.json",
+    "clean": "rimraf ./build",
+    "compile": "tsc -p tsconfig.build.json"
+  }
 }