@peac/schema 0.9.18

package/dist/subject.d.ts

@@ -0,0 +1,111 @@
+/**
+ * PEAC Subject Profile Types
+ *
+ * Subject profiles for identity and authorization context.
+ * Used in conjunction with receipts and control decisions.
+ */
+/**
+ * Subject identifier (opaque string)
+ *
+ * Examples:
+ * - "user:alice@example.com"
+ * - "org:acme-corp"
+ * - "agent:gpt-4-crawler"
+ */
+export type SubjectId = string;
+/**
+ * Subject type classification
+ *
+ * - "human": Individual person
+ * - "org": Organization or legal entity
+ * - "agent": Autonomous software agent (AI, bot, crawler)
+ */
+export type SubjectType = 'human' | 'org' | 'agent';
+/**
+ * Subject profile - identity and classification
+ *
+ * Minimal profile structure for subjects in the PEAC ecosystem.
+ * Profiles are intentionally lightweight; detailed identity
+ * attributes belong in external identity systems.
+ *
+ * Invariants:
+ * - `id` is REQUIRED (non-empty string)
+ * - `type` is REQUIRED (one of: human, org, agent)
+ * - `labels` if present must be non-empty strings
+ */
+export interface SubjectProfile {
+    /**
+     * Subject identifier (REQUIRED)
+     *
+     * Stable, unique identifier for this subject.
+     * Format is application-specific.
+     */
+    id: SubjectId;
+    /**
+     * Subject type (REQUIRED)
+     *
+     * Classification of the subject for policy purposes.
+     */
+    type: SubjectType;
+    /**
+     * Labels for categorization (OPTIONAL)
+     *
+     * Freeform tags for grouping or filtering subjects.
+     * Examples: ["premium", "verified"], ["crawler", "indexer"]
+     */
+    labels?: string[];
+    /**
+     * Additional metadata (OPTIONAL)
+     *
+     * Application-specific attributes.
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Subject profile snapshot - point-in-time capture
+ *
+ * Captures the state of a subject profile at a specific moment.
+ * Used for audit trails, policy evaluation records, and receipts.
+ *
+ * Invariants:
+ * - `subject` is REQUIRED (valid SubjectProfile)
+ * - `captured_at` is REQUIRED (ISO 8601 timestamp)
+ */
+export interface SubjectProfileSnapshot {
+    /**
+     * Subject profile (REQUIRED)
+     *
+     * The captured profile state.
+     */
+    subject: SubjectProfile;
+    /**
+     * Capture timestamp (REQUIRED)
+     *
+     * MUST be an RFC 3339 / ISO 8601 UTC timestamp string.
+     * Examples:
+     * - "2025-01-15T10:30:00Z"
+     * - "2025-01-15T10:30:00.123Z"
+     *
+     * Note: Schema validates non-empty string only; format
+     * enforcement is left to application layer for v0.9.16.
+     */
+    captured_at: string;
+    /**
+     * Source of the snapshot (OPTIONAL)
+     *
+     * Identifies where this profile data came from.
+     * Examples:
+     * - "idp:auth0"
+     * - "directory:ldap"
+     * - "manual"
+     */
+    source?: string;
+    /**
+     * Profile version (OPTIONAL)
+     *
+     * Version tag for the profile schema or data.
+     * Useful for tracking profile format changes over time.
+     */
+    version?: string;
+}
+//# sourceMappingURL=subject.d.ts.map

package/dist/subject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subject.d.ts","sourceRoot":"","sources":["../src/subject.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,CAAC;AAEpD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,EAAE,EAAE,SAAS,CAAC;IAEd;;;;OAIG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB;;;;;;;;;;OAUG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/subject.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * PEAC Subject Profile Types
+ *
+ * Subject profiles for identity and authorization context.
+ * Used in conjunction with receipts and control decisions.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=subject.js.map

package/dist/subject.js.map

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

package/dist/types.d.ts

@@ -0,0 +1,139 @@
+/**
+ * PEAC Protocol TypeScript types
+ */
+import { PEAC_WIRE_TYP, PEAC_ALG } from './constants';
+import type { ControlBlock } from './control';
+import type { PaymentEvidence } from './evidence';
+/**
+ * Subject of the receipt (what was paid for)
+ */
+export interface Subject {
+    /** URI of the resource being paid for */
+    uri: string;
+}
+/**
+ * AIPREF snapshot (if applicable)
+ */
+export interface AIPREFSnapshot {
+    /** URL of the AIPREF document */
+    url: string;
+    /** JCS+SHA-256 hash of the AIPREF document */
+    hash: string;
+}
+/**
+ * Extension fields (additive-only growth path)
+ */
+export interface ReceiptExtensions {
+    /** AIPREF snapshot at time of issuance */
+    aipref_snapshot?: AIPREFSnapshot;
+    /** Control block for mandate management (CAL) */
+    control?: ControlBlock;
+    /** Additional extensions (PEIP-defined) */
+    [key: string]: unknown;
+}
+/**
+ * JWS Header for PEAC receipts
+ */
+export interface PEACReceiptHeader {
+    /** Wire format version - FROZEN at 0.9 until GA */
+    typ: typeof PEAC_WIRE_TYP;
+    /** Signature algorithm - Ed25519 */
+    alg: typeof PEAC_ALG;
+    /** Key ID (ISO 8601 timestamp) */
+    kid: string;
+}
+/**
+ * PEAC Receipt Claims (JWS payload)
+ */
+export interface PEACReceiptClaims {
+    /** Issuer URL (https://) */
+    iss: string;
+    /** Audience / resource URL */
+    aud: string;
+    /** Issued at (Unix timestamp seconds) */
+    iat: number;
+    /** Expiry (Unix timestamp seconds, optional) */
+    exp?: number;
+    /** Receipt ID (UUIDv7) */
+    rid: string;
+    /** Amount (smallest currency unit) */
+    amt: number;
+    /** Currency (ISO 4217 uppercase) */
+    cur: string;
+    /** Normalized payment details */
+    payment: PaymentEvidence;
+    /** Subject (what was paid for) */
+    subject?: Subject;
+    /** Extensions (additive-only) */
+    ext?: ReceiptExtensions;
+}
+/**
+ * Complete PEAC Receipt (header + claims)
+ */
+export interface PEACReceipt {
+    header: PEACReceiptHeader;
+    claims: PEACReceiptClaims;
+}
+/**
+ * Verify request body
+ */
+export interface VerifyRequest {
+    /** JWS compact serialization */
+    receipt_jws: string;
+}
+/**
+ * Verify response (success)
+ */
+export interface VerifyResponseSuccess {
+    /** Verification succeeded */
+    ok: true;
+    /** JWS header (decoded) */
+    header: PEACReceiptHeader;
+    /** Claims (decoded and validated) */
+    claims: PEACReceiptClaims;
+    /** Performance metrics */
+    perf?: {
+        verify_ms: number;
+        jwks_fetch_ms?: number;
+    };
+}
+/**
+ * Verify response (failure)
+ */
+export interface VerifyResponseFailure {
+    /** Verification failed */
+    ok: false;
+    /** Error reason */
+    reason: string;
+    /** Error details */
+    details?: string;
+}
+/**
+ * Verify response (union)
+ */
+export type VerifyResponse = VerifyResponseSuccess | VerifyResponseFailure;
+/**
+ * Discovery manifest (peac.txt parsed)
+ */
+export interface PEACDiscovery {
+    /** PEAC protocol version */
+    version: string;
+    /** Issuer URL */
+    issuer: string;
+    /** Verify endpoint URL */
+    verify: string;
+    /** JWKS URL */
+    jwks: string;
+    /** Supported payment rails */
+    payments: Array<{
+        rail: string;
+        info?: string;
+    }>;
+    /** AIPREF URL (optional) */
+    aipref?: string;
+    /** SLO endpoint (optional) */
+    slos?: string;
+    /** Security contact (optional) */
+    security?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAiB,MAAM,YAAY,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,yCAAyC;IACzC,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,iCAAiC;IACjC,GAAG,EAAE,MAAM,CAAC;IAEZ,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,0CAA0C;IAC1C,eAAe,CAAC,EAAE,cAAc,CAAC;IAEjC,iDAAiD;IACjD,OAAO,CAAC,EAAE,YAAY,CAAC;IAEvB,2CAA2C;IAC3C,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,mDAAmD;IACnD,GAAG,EAAE,OAAO,aAAa,CAAC;IAE1B,oCAAoC;IACpC,GAAG,EAAE,OAAO,QAAQ,CAAC;IAErB,kCAAkC;IAClC,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,4BAA4B;IAC5B,GAAG,EAAE,MAAM,CAAC;IAEZ,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IAEZ,yCAAyC;IACzC,GAAG,EAAE,MAAM,CAAC;IAEZ,gDAAgD;IAChD,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAC;IAEZ,sCAAsC;IACtC,GAAG,EAAE,MAAM,CAAC;IAEZ,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAC;IAEZ,iCAAiC;IACjC,OAAO,EAAE,eAAe,CAAC;IAEzB,kCAAkC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,iCAAiC;IACjC,GAAG,CAAC,EAAE,iBAAiB,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,iBAAiB,CAAC;IAC1B,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,6BAA6B;IAC7B,EAAE,EAAE,IAAI,CAAC;IAET,2BAA2B;IAC3B,MAAM,EAAE,iBAAiB,CAAC;IAE1B,qCAAqC;IACrC,MAAM,EAAE,iBAAiB,CAAC;IAE1B,0BAA0B;IAC1B,IAAI,CAAC,EAAE;QACL,SAAS,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,0BAA0B;IAC1B,EAAE,EAAE,KAAK,CAAC;IAEV,mBAAmB;IACnB,MAAM,EAAE,MAAM,CAAC;IAEf,oBAAoB;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,qBAAqB,GAAG,qBAAqB,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,4BAA4B;IAC5B,OAAO,EAAE,MAAM,CAAC;IAEhB,iBAAiB;IACjB,MAAM,EAAE,MAAM,CAAC;IAEf,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IAEf,eAAe;IACf,IAAI,EAAE,MAAM,CAAC;IAEb,8BAA8B;IAC9B,QAAQ,EAAE,KAAK,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC,CAAC;IAEH,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/types.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * PEAC Protocol TypeScript types
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

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