@appport/sdk 1.0.2 → 1.1.1

package/vendor/@appport/core/dist/appboundry-capability-catalog.d.ts

@@ -0,0 +1,930 @@
+import { type Schema } from "../../schema/dist/index.d.ts";
+export declare const APPBOUNDRY_CANONICAL_CAPABILITY_VERSION = 1;
+export interface CanonicalCapabilityRequirement {
+    readonly name: string;
+    readonly version: number;
+}
+export interface CanonicalCapabilityDefinition<Input = unknown, Output = unknown> {
+    readonly id: `${string}@${number}`;
+    readonly name: string;
+    readonly version: number;
+    readonly description: string;
+    readonly input: Schema<Input>;
+    readonly output: Schema<Output>;
+    readonly requirements?: readonly CanonicalCapabilityRequirement[];
+}
+export declare function canonicalCapabilityId(name: string, version?: number): `${string}@${number}`;
+export declare const canonicalCapabilities: readonly (CanonicalCapabilityDefinition<{
+    id: string;
+}, {
+    found: boolean;
+    identity?: Record<string, unknown> | undefined;
+}> | CanonicalCapabilityDefinition<{
+    subject: {
+        id: string;
+    };
+    assertion: string;
+}, {
+    verified: boolean;
+    reasons?: string[] | undefined;
+}> | CanonicalCapabilityDefinition<{
+    attributes: Record<string, unknown>;
+}, {
+    resolved: boolean;
+    identity?: {
+        id: string;
+    } | undefined;
+    candidates?: {
+        id: string;
+    }[] | undefined;
+}> | CanonicalCapabilityDefinition<{
+    subject: {
+        id: string;
+    };
+    action: string;
+    resource: {
+        id: string;
+    };
+}, {
+    allowed: boolean;
+    reasons?: string[] | undefined;
+}> | CanonicalCapabilityDefinition<{
+    subject: {
+        id: string;
+    };
+    scope?: {
+        id: string;
+    } | undefined;
+}, {
+    roles: string[];
+}> | CanonicalCapabilityDefinition<{
+    id: string;
+}, {
+    found: boolean;
+    organization?: Record<string, unknown> | undefined;
+}> | CanonicalCapabilityDefinition<{
+    subject: string;
+    to: string[];
+    body: string;
+    from?: string | undefined;
+}, {
+    accepted: boolean;
+    messageId?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    email: string;
+}, {
+    valid: boolean;
+    reasons?: string[] | undefined;
+    normalized?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    phone: string;
+    country?: string | undefined;
+}, {
+    valid: boolean;
+    reasons?: string[] | undefined;
+    normalized?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    to: string;
+    body: string;
+    from?: string | undefined;
+}, {
+    accepted: boolean;
+    messageId?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    body: string;
+    recipient: {
+        id: string;
+    };
+    channel?: string | undefined;
+    title?: string | undefined;
+}, {
+    accepted: boolean;
+    notificationId?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    body: string;
+    target: string;
+    title?: string | undefined;
+    data?: Record<string, unknown> | undefined;
+}, {
+    accepted: boolean;
+    messageId?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    data: Record<string, unknown>;
+    template: string;
+}, {
+    content: string;
+    contentType?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    data: Record<string, unknown>;
+    template: string;
+    format?: string | undefined;
+}, {
+    data: string;
+    contentType: string;
+}> | CanonicalCapabilityDefinition<{
+    document: {
+        data: string;
+        contentType: string;
+    };
+    toFormat: string;
+}, {
+    data: string;
+    contentType: string;
+}> | CanonicalCapabilityDefinition<{
+    document: {
+        data: string;
+        contentType: string;
+    };
+    target?: string | undefined;
+}, {
+    data: string;
+    contentType: string;
+}> | CanonicalCapabilityDefinition<{
+    document: {
+        data: string;
+        contentType: string;
+    };
+    fields?: string[] | undefined;
+}, {
+    fields?: Record<string, unknown> | undefined;
+    text?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    data: string;
+    contentType: string;
+    name?: string | undefined;
+}, {
+    file: {
+        id: string;
+        uri?: string | undefined;
+    };
+}> | CanonicalCapabilityDefinition<{
+    file: {
+        id: string;
+        uri?: string | undefined;
+    };
+}, {
+    data: string;
+    contentType: string;
+    name?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    file: {
+        id: string;
+        uri?: string | undefined;
+    };
+    transform: string;
+    options?: Record<string, unknown> | undefined;
+}, {
+    file: {
+        id: string;
+        uri?: string | undefined;
+    };
+    contentType?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    file: {
+        id: string;
+        uri?: string | undefined;
+    };
+    algorithm?: string | undefined;
+}, {
+    value: string;
+    algorithm: string;
+}> | CanonicalCapabilityDefinition<{
+    collection: string;
+    key: string;
+}, {
+    found: boolean;
+    record?: Record<string, unknown> | undefined;
+}> | CanonicalCapabilityDefinition<{
+    collection: string;
+    query?: string | undefined;
+    filters?: Record<string, unknown> | undefined;
+    limit?: number | undefined;
+}, {
+    records: Record<string, unknown>[];
+    total?: number | undefined;
+}> | CanonicalCapabilityDefinition<{
+    data: Record<string, unknown>;
+    rules?: string[] | undefined;
+}, {
+    valid: boolean;
+    reasons?: string[] | undefined;
+}> | CanonicalCapabilityDefinition<{
+    data: Record<string, unknown>;
+    profile?: string | undefined;
+}, {
+    data: Record<string, unknown>;
+}> | CanonicalCapabilityDefinition<{
+    data: Record<string, unknown>;
+    fields?: string[] | undefined;
+}, {
+    data: Record<string, unknown>;
+}> | CanonicalCapabilityDefinition<{
+    format: string;
+    records: Record<string, unknown>[];
+}, {
+    data: string;
+    contentType: string;
+}> | CanonicalCapabilityDefinition<{
+    amount: {
+        amount: number;
+        currency: string;
+    };
+    paymentMethod: string;
+    reference?: string | undefined;
+}, {
+    authorized: boolean;
+    reasons?: string[] | undefined;
+    authorizationId?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    authorizationId: string;
+    amount?: {
+        amount: number;
+        currency: string;
+    } | undefined;
+}, {
+    captured: boolean;
+    reasons?: string[] | undefined;
+    captureId?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    paymentId: string;
+    amount?: {
+        amount: number;
+        currency: string;
+    } | undefined;
+    reason?: string | undefined;
+}, {
+    refunded: boolean;
+    reasons?: string[] | undefined;
+    refundId?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    paymentMethod: Record<string, unknown>;
+}, {
+    token: string;
+    expiresAt?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    customer: {
+        id: string;
+    };
+    lineItems: {
+        amount: {
+            amount: number;
+            currency: string;
+        };
+        description: string;
+    }[];
+}, {
+    total: {
+        amount: number;
+        currency: string;
+    };
+    invoiceId: string;
+}> | CanonicalCapabilityDefinition<{
+    amount: {
+        amount: number;
+        currency: string;
+    };
+    jurisdiction: string;
+    address?: {
+        country: string;
+        line1: string;
+        line2?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        postalCode?: string | undefined;
+    } | undefined;
+}, {
+    tax: {
+        amount: number;
+        currency: string;
+    };
+    rate?: number | undefined;
+}> | CanonicalCapabilityDefinition<{
+    address: {
+        country: string;
+        line1: string;
+        line2?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        postalCode?: string | undefined;
+    };
+}, {
+    valid: boolean;
+    reasons?: string[] | undefined;
+    normalized?: {
+        country: string;
+        line1: string;
+        line2?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        postalCode?: string | undefined;
+    } | undefined;
+}> | CanonicalCapabilityDefinition<{
+    address: {
+        country: string;
+        line1: string;
+        line2?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        postalCode?: string | undefined;
+    };
+}, {
+    address: {
+        country: string;
+        line1: string;
+        line2?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        postalCode?: string | undefined;
+    };
+}> | CanonicalCapabilityDefinition<{
+    address: {
+        country: string;
+        line1: string;
+        line2?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        postalCode?: string | undefined;
+    };
+}, {
+    latitude: number;
+    longitude: number;
+    accuracy?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    latitude: number;
+    longitude: number;
+}, {
+    address?: {
+        country: string;
+        line1: string;
+        line2?: string | undefined;
+        city?: string | undefined;
+        region?: string | undefined;
+        postalCode?: string | undefined;
+    } | undefined;
+    formatted?: string | undefined;
+}> | CanonicalCapabilityDefinition<{
+    to: {
+        latitude: number;
+        longitude: number;
+    };
+    from: {
+        latitude: number;
+        longitude: number;
+    };
+    unit?: string | undefined;
+}, {
+    unit: string;
+    distance: number;
+}> | CanonicalCapabilityDefinition<{
+    latitude: number;
+    longitude: number;
+    at?: string | undefined;
+}, {
+    timezone: string;
+    offsetMinutes?: number | undefined;
+}> | CanonicalCapabilityDefinition<{
+    value: string;
+    format: string;
+}, {
+    data: string;
+    contentType: string;
+}> | CanonicalCapabilityDefinition<{
+    value: string;
+    size?: number | undefined;
+}, {
+    data: string;
+    contentType: string;
+}> | CanonicalCapabilityDefinition<{
+    size: {
+        width: number;
+        height: number;
+    };
+    image: {
+        data: string;
+        contentType: string;
+    };
+}, {
+    data: string;
+    contentType: string;
+    size: {
+        width: number;
+        height: number;
+    };
+}> | CanonicalCapabilityDefinition<{
+    toFormat: string;
+    image: {
+        data: string;
+        contentType: string;
+    };
+}, {
+    data: string;
+    contentType: string;
+}> | CanonicalCapabilityDefinition<{
+    source: {
+        data: string;
+        contentType: string;
+    };
+}, {
+    text: string;
+}> | CanonicalCapabilityDefinition<{
+    text: string;
+    operation: string;
+    options?: Record<string, unknown> | undefined;
+}, {
+    text: string;
+}> | CanonicalCapabilityDefinition<{
+    version?: string | undefined;
+}, {
+    value: string;
+}> | CanonicalCapabilityDefinition<{
+    value: string;
+    amount: number;
+    unit: string;
+    operation: string;
+}, {
+    value: string;
+}> | CanonicalCapabilityDefinition<{
+    to: string;
+    from: string;
+    amount: number;
+}, {
+    to: string;
+    from: string;
+    amount: number;
+}> | CanonicalCapabilityDefinition<{
+    value: number;
+    to: string;
+    from: string;
+}, {
+    value: number;
+    to: string;
+    from: string;
+}> | CanonicalCapabilityDefinition<{
+    algorithm: string;
+    payload: string;
+    signature: string;
+    keyId?: string | undefined;
+}, {
+    valid: boolean;
+    reason?: string | undefined;
+}>)[];
+export type CanonicalCapabilityName = (typeof canonicalCapabilities)[number]["name"];
+export declare function getCanonicalCapability(name: CanonicalCapabilityName | string, version?: number): CanonicalCapabilityDefinition | undefined;
+export declare function hasCanonicalCapability(name: CanonicalCapabilityName | string, version?: number): boolean;
+export declare const canonicalCapabilityCatalog: Readonly<{
+    [k: string]: CanonicalCapabilityDefinition<{
+        id: string;
+    }, {
+        found: boolean;
+        identity?: Record<string, unknown> | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        subject: {
+            id: string;
+        };
+        assertion: string;
+    }, {
+        verified: boolean;
+        reasons?: string[] | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        attributes: Record<string, unknown>;
+    }, {
+        resolved: boolean;
+        identity?: {
+            id: string;
+        } | undefined;
+        candidates?: {
+            id: string;
+        }[] | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        subject: {
+            id: string;
+        };
+        action: string;
+        resource: {
+            id: string;
+        };
+    }, {
+        allowed: boolean;
+        reasons?: string[] | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        subject: {
+            id: string;
+        };
+        scope?: {
+            id: string;
+        } | undefined;
+    }, {
+        roles: string[];
+    }> | CanonicalCapabilityDefinition<{
+        id: string;
+    }, {
+        found: boolean;
+        organization?: Record<string, unknown> | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        subject: string;
+        to: string[];
+        body: string;
+        from?: string | undefined;
+    }, {
+        accepted: boolean;
+        messageId?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        email: string;
+    }, {
+        valid: boolean;
+        reasons?: string[] | undefined;
+        normalized?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        phone: string;
+        country?: string | undefined;
+    }, {
+        valid: boolean;
+        reasons?: string[] | undefined;
+        normalized?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        to: string;
+        body: string;
+        from?: string | undefined;
+    }, {
+        accepted: boolean;
+        messageId?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        body: string;
+        recipient: {
+            id: string;
+        };
+        channel?: string | undefined;
+        title?: string | undefined;
+    }, {
+        accepted: boolean;
+        notificationId?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        body: string;
+        target: string;
+        title?: string | undefined;
+        data?: Record<string, unknown> | undefined;
+    }, {
+        accepted: boolean;
+        messageId?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        data: Record<string, unknown>;
+        template: string;
+    }, {
+        content: string;
+        contentType?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        data: Record<string, unknown>;
+        template: string;
+        format?: string | undefined;
+    }, {
+        data: string;
+        contentType: string;
+    }> | CanonicalCapabilityDefinition<{
+        document: {
+            data: string;
+            contentType: string;
+        };
+        toFormat: string;
+    }, {
+        data: string;
+        contentType: string;
+    }> | CanonicalCapabilityDefinition<{
+        document: {
+            data: string;
+            contentType: string;
+        };
+        target?: string | undefined;
+    }, {
+        data: string;
+        contentType: string;
+    }> | CanonicalCapabilityDefinition<{
+        document: {
+            data: string;
+            contentType: string;
+        };
+        fields?: string[] | undefined;
+    }, {
+        fields?: Record<string, unknown> | undefined;
+        text?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        data: string;
+        contentType: string;
+        name?: string | undefined;
+    }, {
+        file: {
+            id: string;
+            uri?: string | undefined;
+        };
+    }> | CanonicalCapabilityDefinition<{
+        file: {
+            id: string;
+            uri?: string | undefined;
+        };
+    }, {
+        data: string;
+        contentType: string;
+        name?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        file: {
+            id: string;
+            uri?: string | undefined;
+        };
+        transform: string;
+        options?: Record<string, unknown> | undefined;
+    }, {
+        file: {
+            id: string;
+            uri?: string | undefined;
+        };
+        contentType?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        file: {
+            id: string;
+            uri?: string | undefined;
+        };
+        algorithm?: string | undefined;
+    }, {
+        value: string;
+        algorithm: string;
+    }> | CanonicalCapabilityDefinition<{
+        collection: string;
+        key: string;
+    }, {
+        found: boolean;
+        record?: Record<string, unknown> | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        collection: string;
+        query?: string | undefined;
+        filters?: Record<string, unknown> | undefined;
+        limit?: number | undefined;
+    }, {
+        records: Record<string, unknown>[];
+        total?: number | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        data: Record<string, unknown>;
+        rules?: string[] | undefined;
+    }, {
+        valid: boolean;
+        reasons?: string[] | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        data: Record<string, unknown>;
+        profile?: string | undefined;
+    }, {
+        data: Record<string, unknown>;
+    }> | CanonicalCapabilityDefinition<{
+        data: Record<string, unknown>;
+        fields?: string[] | undefined;
+    }, {
+        data: Record<string, unknown>;
+    }> | CanonicalCapabilityDefinition<{
+        format: string;
+        records: Record<string, unknown>[];
+    }, {
+        data: string;
+        contentType: string;
+    }> | CanonicalCapabilityDefinition<{
+        amount: {
+            amount: number;
+            currency: string;
+        };
+        paymentMethod: string;
+        reference?: string | undefined;
+    }, {
+        authorized: boolean;
+        reasons?: string[] | undefined;
+        authorizationId?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        authorizationId: string;
+        amount?: {
+            amount: number;
+            currency: string;
+        } | undefined;
+    }, {
+        captured: boolean;
+        reasons?: string[] | undefined;
+        captureId?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        paymentId: string;
+        amount?: {
+            amount: number;
+            currency: string;
+        } | undefined;
+        reason?: string | undefined;
+    }, {
+        refunded: boolean;
+        reasons?: string[] | undefined;
+        refundId?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        paymentMethod: Record<string, unknown>;
+    }, {
+        token: string;
+        expiresAt?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        customer: {
+            id: string;
+        };
+        lineItems: {
+            amount: {
+                amount: number;
+                currency: string;
+            };
+            description: string;
+        }[];
+    }, {
+        total: {
+            amount: number;
+            currency: string;
+        };
+        invoiceId: string;
+    }> | CanonicalCapabilityDefinition<{
+        amount: {
+            amount: number;
+            currency: string;
+        };
+        jurisdiction: string;
+        address?: {
+            country: string;
+            line1: string;
+            line2?: string | undefined;
+            city?: string | undefined;
+            region?: string | undefined;
+            postalCode?: string | undefined;
+        } | undefined;
+    }, {
+        tax: {
+            amount: number;
+            currency: string;
+        };
+        rate?: number | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        address: {
+            country: string;
+            line1: string;
+            line2?: string | undefined;
+            city?: string | undefined;
+            region?: string | undefined;
+            postalCode?: string | undefined;
+        };
+    }, {
+        valid: boolean;
+        reasons?: string[] | undefined;
+        normalized?: {
+            country: string;
+            line1: string;
+            line2?: string | undefined;
+            city?: string | undefined;
+            region?: string | undefined;
+            postalCode?: string | undefined;
+        } | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        address: {
+            country: string;
+            line1: string;
+            line2?: string | undefined;
+            city?: string | undefined;
+            region?: string | undefined;
+            postalCode?: string | undefined;
+        };
+    }, {
+        address: {
+            country: string;
+            line1: string;
+            line2?: string | undefined;
+            city?: string | undefined;
+            region?: string | undefined;
+            postalCode?: string | undefined;
+        };
+    }> | CanonicalCapabilityDefinition<{
+        address: {
+            country: string;
+            line1: string;
+            line2?: string | undefined;
+            city?: string | undefined;
+            region?: string | undefined;
+            postalCode?: string | undefined;
+        };
+    }, {
+        latitude: number;
+        longitude: number;
+        accuracy?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        latitude: number;
+        longitude: number;
+    }, {
+        address?: {
+            country: string;
+            line1: string;
+            line2?: string | undefined;
+            city?: string | undefined;
+            region?: string | undefined;
+            postalCode?: string | undefined;
+        } | undefined;
+        formatted?: string | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        to: {
+            latitude: number;
+            longitude: number;
+        };
+        from: {
+            latitude: number;
+            longitude: number;
+        };
+        unit?: string | undefined;
+    }, {
+        unit: string;
+        distance: number;
+    }> | CanonicalCapabilityDefinition<{
+        latitude: number;
+        longitude: number;
+        at?: string | undefined;
+    }, {
+        timezone: string;
+        offsetMinutes?: number | undefined;
+    }> | CanonicalCapabilityDefinition<{
+        value: string;
+        format: string;
+    }, {
+        data: string;
+        contentType: string;
+    }> | CanonicalCapabilityDefinition<{
+        value: string;
+        size?: number | undefined;
+    }, {
+        data: string;
+        contentType: string;
+    }> | CanonicalCapabilityDefinition<{
+        size: {
+            width: number;
+            height: number;
+        };
+        image: {
+            data: string;
+            contentType: string;
+        };
+    }, {
+        data: string;
+        contentType: string;
+        size: {
+            width: number;
+            height: number;
+        };
+    }> | CanonicalCapabilityDefinition<{
+        toFormat: string;
+        image: {
+            data: string;
+            contentType: string;
+        };
+    }, {
+        data: string;
+        contentType: string;
+    }> | CanonicalCapabilityDefinition<{
+        source: {
+            data: string;
+            contentType: string;
+        };
+    }, {
+        text: string;
+    }> | CanonicalCapabilityDefinition<{
+        text: string;
+        operation: string;
+        options?: Record<string, unknown> | undefined;
+    }, {
+        text: string;
+    }> | CanonicalCapabilityDefinition<{
+        version?: string | undefined;
+    }, {
+        value: string;
+    }> | CanonicalCapabilityDefinition<{
+        value: string;
+        amount: number;
+        unit: string;
+        operation: string;
+    }, {
+        value: string;
+    }> | CanonicalCapabilityDefinition<{
+        to: string;
+        from: string;
+        amount: number;
+    }, {
+        to: string;
+        from: string;
+        amount: number;
+    }> | CanonicalCapabilityDefinition<{
+        value: number;
+        to: string;
+        from: string;
+    }, {
+        value: number;
+        to: string;
+        from: string;
+    }> | CanonicalCapabilityDefinition<{
+        algorithm: string;
+        payload: string;
+        signature: string;
+        keyId?: string | undefined;
+    }, {
+        valid: boolean;
+        reason?: string | undefined;
+    }>;
+}>;
+//# sourceMappingURL=appboundry-capability-catalog.d.ts.map