@eventsdk/sdk 0.0.0-stage → 0.4.0

package/dist/conformance/version/compatibility.d.ts

@@ -0,0 +1,13 @@
+export interface VersionSet {
+    readonly sdkVersion: string;
+    readonly profile: string;
+    readonly cloudEvents: string;
+    readonly schemaMajor: number;
+}
+export type Compatibility = {
+    readonly compatible: true;
+} | {
+    readonly compatible: false;
+    readonly reason: 'UNSUPPORTED_VERSION' | 'PROFILE_MISMATCH';
+};
+export declare function checkCompatibility(producer: VersionSet, consumer: VersionSet): Compatibility;

package/dist/contracts/canonical/canonical-json.d.ts

@@ -0,0 +1 @@
+export declare function canonicalJson(value: unknown): string;

package/dist/contracts/contract-types.d.ts

@@ -0,0 +1,34 @@
+import type { CloudEventFanout } from './generated/cloud-event-fanout.js';
+import type { FanoutEventDraft as GeneratedFanoutDraft } from './generated/fanout-event-draft.js';
+import type { CloudEventContext as GeneratedContextEvent } from './generated/cloud-event-context.js';
+import type { NamespacedReference as GeneratedReference } from './generated/namespaced-reference.js';
+import type { IdentityContext as GeneratedIdentityContext } from './generated/identity-context.js';
+import type { CloudEvent as GeneratedEvent } from './generated/cloud-event.js';
+import type { BusinessReceipt as GeneratedReceipt } from './generated/business-receipt.js';
+import type { ResultRef as GeneratedResult } from './generated/result-ref.js';
+import type { TenantContext as GeneratedContext } from './generated/tenant-context.js';
+import type { TenantConnection as GeneratedConnection } from './generated/tenant-connection.js';
+import type { ExchangeGrant as GeneratedGrant } from './generated/exchange-grant.js';
+type Immutable<T> = T extends readonly (infer U)[] ? readonly Immutable<U>[] : T extends object ? {
+    readonly [Key in keyof T]: Immutable<T[Key]>;
+} : T;
+export type JsonValue = null | boolean | number | string | readonly JsonValue[] | {
+    readonly [key: string]: JsonValue;
+};
+export type CloudEventV1 = Immutable<GeneratedEvent>;
+export type CloudEventV11 = Immutable<GeneratedContextEvent>;
+export type CloudEventV12 = Immutable<CloudEventFanout>;
+export type FanoutEventDraft = Immutable<GeneratedFanoutDraft>;
+export type CloudEvent = CloudEventV1 | CloudEventV11 | CloudEventV12;
+export type NamespacedReference = Immutable<GeneratedReference>;
+export type IdentityContext = Immutable<GeneratedIdentityContext>;
+export type BusinessReceipt = Immutable<GeneratedReceipt>;
+export type ReceiptDisposition = BusinessReceipt['disposition'];
+export type ResultRef = Immutable<GeneratedResult>;
+export type TenantContext = Immutable<GeneratedContext>;
+export type TenantConnection = Immutable<GeneratedConnection>;
+export type ExchangeGrant = Immutable<GeneratedGrant>;
+export type { EventOriginClaims } from './generated/event-origin-claims.js';
+export type { NodeConnectionProfile } from './generated/node-connection-profile.js';
+export type { PublicJwksSnapshot } from './generated/public-jwks-snapshot.js';
+export type { ExchangeRegistration } from './generated/exchange-registration.js';

package/dist/contracts/generated/business-receipt.d.ts

@@ -0,0 +1,21 @@
+export interface BusinessReceipt {
+    receiptRef: string;
+    originSource: string;
+    originEventId: string;
+    deliveryRef: string;
+    consumerRef: string;
+    targetScope: string;
+    disposition: 'RECEIVED' | 'APPLIED' | 'REJECTED' | 'HOLD' | 'UNKNOWN';
+    recordedAt: string;
+    revision: number;
+    reasonCode?: string;
+    resultRef?: ResultRef;
+}
+export interface ResultRef {
+    sourceSystem: string;
+    resourceType: string;
+    resourceId: string;
+    revision: string;
+    digest: string;
+    evidenceRef?: string;
+}

package/dist/contracts/generated/cloud-event-context.d.ts

@@ -0,0 +1,32 @@
+export type JsonValue = null | boolean | number | string | JsonValue[] | {
+    [k: string]: JsonValue;
+};
+export interface CloudEventContext {
+    specversion: '1.0';
+    id: string;
+    source: string;
+    type: string;
+    time: string;
+    dataschema: string;
+    datacontenttype: 'application/json';
+    profile: 'eventsdk/1.1';
+    kind: 'EVENT' | 'HANDOFF' | 'RECEIPT';
+    serviceorigin: string;
+    sourcetenant: string;
+    audience: string;
+    connectionref: string;
+    grantref: string;
+    grantversion: number;
+    correlationid: string;
+    causationid?: string;
+    subject?: string;
+    data: JsonValue;
+    orgnamespace?: string;
+    orgref?: string;
+    projectnamespace?: string;
+    projectref?: string;
+    principalnamespace?: string;
+    principalref?: string;
+    resourcenamespace?: string;
+    resourceref?: string;
+}

package/dist/contracts/generated/cloud-event-fanout.d.ts

@@ -0,0 +1,33 @@
+export type JsonValue = null | boolean | number | string | JsonValue[] | {
+    [k: string]: JsonValue;
+};
+export interface CloudEventFanout {
+    specversion: '1.0';
+    id: string;
+    source: string;
+    type: string;
+    time: string;
+    dataschema: string;
+    datacontenttype: 'application/json';
+    profile: 'eventsdk/1.2';
+    kind: 'EVENT';
+    serviceorigin: string;
+    sourcetenant: string;
+    audience: string;
+    connectionref: string;
+    grantref: string;
+    grantversion: number;
+    correlationid: string;
+    causationid?: string;
+    subject?: string;
+    data: JsonValue;
+    orgnamespace?: string;
+    orgref?: string;
+    projectnamespace?: string;
+    projectref?: string;
+    principalnamespace?: string;
+    principalref?: string;
+    resourcenamespace?: string;
+    resourceref?: string;
+    deliveryid: string;
+}

package/dist/contracts/generated/cloud-event.d.ts

@@ -0,0 +1,24 @@
+export type JsonValue = null | boolean | number | string | JsonValue[] | {
+    [k: string]: JsonValue;
+};
+export interface CloudEvent {
+    specversion: '1.0';
+    id: string;
+    source: string;
+    type: string;
+    time: string;
+    dataschema: string;
+    datacontenttype: 'application/json';
+    profile: 'eventsdk/1.0';
+    kind: 'EVENT' | 'HANDOFF' | 'RECEIPT';
+    serviceorigin: string;
+    sourcetenant: string;
+    audience: string;
+    connectionref: string;
+    grantref: string;
+    grantversion: number;
+    correlationid: string;
+    causationid?: string;
+    subject?: string;
+    data: JsonValue;
+}

package/dist/contracts/generated/event-link-authorization-request.d.ts

@@ -0,0 +1,22 @@
+export interface EventLinkAuthorizationRequest {
+    profile: 'event-link/1';
+    response_type: 'code';
+    client_id: string;
+    redirect_uri: string;
+    scope: 'eventsdk.connection.authorize';
+    state: string;
+    code_challenge: string;
+    code_challenge_method: 'S256';
+    request_id: string;
+    source: Source;
+    event_type: string;
+    grant_ref: string;
+    grant_version: '1';
+}
+export interface Source {
+    source: string;
+    serviceRef: string;
+    tenantRef: string;
+    issuer: string;
+    subject: string;
+}

package/dist/contracts/generated/event-link-proposal.d.ts

@@ -0,0 +1,27 @@
+export interface EventLinkProposal {
+    schemaVersion: 1;
+    requestId: string;
+    source: Source;
+    target: TenantContext;
+    grant: {
+        grantRef: string;
+        version: 1;
+        eventType: string;
+        consumerRef: string;
+    };
+    connectionRef: string;
+    targetDisplayName: string;
+    approvalRef: string;
+    expiresAt: string;
+}
+export interface Source {
+    source: string;
+    serviceRef: string;
+    tenantRef: string;
+    issuer: string;
+    subject: string;
+}
+export interface TenantContext {
+    serviceRef: string;
+    tenantRef: string;
+}

package/dist/contracts/generated/event-link-token-request.d.ts

@@ -0,0 +1,7 @@
+export interface EventLinkTokenRequest {
+    grant_type: 'authorization_code';
+    client_id: string;
+    redirect_uri: string;
+    code: string;
+    code_verifier: string;
+}

package/dist/contracts/generated/event-origin-claims.d.ts

@@ -0,0 +1,13 @@
+export interface EventOriginClaims {
+    schemaVersion: 1;
+    purpose: 'eventsdk-origin/1';
+    issuer: string;
+    subject: string;
+    serviceRef: string;
+    audience: string;
+    source: string;
+    eventId: string;
+    deliveryId?: string;
+    eventDigest: string;
+    signedAt: string;
+}

package/dist/contracts/generated/exchange-grant.d.ts

@@ -0,0 +1,11 @@
+export interface ExchangeGrant {
+    grantRef: string;
+    version: number;
+    connectionRef: string;
+    direction: 'OUTBOUND' | 'INBOUND';
+    status: 'ACTIVE' | 'SUSPENDED' | 'REVOKED';
+    eventTypes: [string, ...string[]];
+    audience: string;
+    notBefore: string;
+    expiresAt: string;
+}

package/dist/contracts/generated/exchange-registration.d.ts

@@ -0,0 +1,24 @@
+export interface ExchangeRegistration {
+    schemaVersion: 1;
+    requestId: string;
+    expectedRevision: number | null;
+    source: {
+        source: string;
+        serviceRef: string;
+        tenantRef: string;
+        issuer: string;
+        subject: string;
+    };
+    target: TenantContext;
+    grant: {
+        grantRef: string;
+        version: number;
+        eventType: string;
+        consumerRef: string;
+    };
+    status: 'ACTIVE' | 'REVOKED';
+}
+export interface TenantContext {
+    serviceRef: string;
+    tenantRef: string;
+}

package/dist/contracts/generated/fanout-event-draft.d.ts

@@ -0,0 +1,28 @@
+export type JsonValue = null | boolean | number | string | JsonValue[] | {
+    [k: string]: JsonValue;
+};
+export interface FanoutEventDraft {
+    specversion: '1.0';
+    id: string;
+    source: string;
+    type: string;
+    time: string;
+    dataschema: string;
+    datacontenttype: 'application/json';
+    profile: 'eventsdk/1.2';
+    kind: 'EVENT';
+    serviceorigin: string;
+    sourcetenant: string;
+    correlationid: string;
+    causationid?: string;
+    subject?: string;
+    data: JsonValue;
+    orgnamespace?: string;
+    orgref?: string;
+    projectnamespace?: string;
+    projectref?: string;
+    principalnamespace?: string;
+    principalref?: string;
+    resourcenamespace?: string;
+    resourceref?: string;
+}

package/dist/contracts/generated/gap-baseline.d.ts

@@ -0,0 +1,18 @@
+export interface GapBaseline {
+    schemaVersion: 1;
+    baselineRef: string;
+    source: string;
+    sourceTenant: string;
+    targetService: string;
+    targetTenant: string;
+    connectionRef: string;
+    grantRef: string;
+    grantVersion: number;
+    previousWatermark: string;
+    retainedThrough: string;
+    watermark: string;
+    sourceRevision: string;
+    createdAt: string;
+    readModel: 'AUTHORITATIVE_ON_DEMAND';
+    directoryRef: string;
+}

package/dist/contracts/generated/gap-recovery-command.d.ts

@@ -0,0 +1,7 @@
+export interface GapRecoveryCommand {
+    schemaVersion: 1;
+    requestId: string;
+    connectionRef: string;
+    expectedCursor: string;
+    expectedOldestAvailableCursor: string;
+}

package/dist/contracts/generated/identity-context.d.ts

@@ -0,0 +1,15 @@
+export interface IdentityContext {
+    sourceTenant: TenantContext;
+    organization?: NamespacedReference;
+    project?: NamespacedReference;
+    actorPrincipal?: NamespacedReference;
+    resource?: NamespacedReference;
+}
+export interface TenantContext {
+    serviceRef: string;
+    tenantRef: string;
+}
+export interface NamespacedReference {
+    namespace: string;
+    ref: string;
+}

package/dist/contracts/generated/namespaced-reference.d.ts

@@ -0,0 +1,4 @@
+export interface NamespacedReference {
+    namespace: string;
+    ref: string;
+}

package/dist/contracts/generated/native-event-catalog.d.ts

@@ -0,0 +1,19 @@
+export type JsonValue = null | boolean | number | string | JsonValue[] | {
+    [k: string]: JsonValue;
+};
+export interface NativeEventCatalog {
+    schemaVersion: 1;
+    serviceRef: string;
+    events: {
+        type: string;
+        dataschema: string;
+        description: string;
+        dataSchema: {
+            [k: string]: JsonValue;
+        };
+        resourceAccess: {
+            providerPath: string;
+            tools: [string, ...string[]];
+        };
+    }[];
+}

package/dist/contracts/generated/node-connection-profile.d.ts

@@ -0,0 +1,217 @@
+export type Ref = string;
+export type File = string;
+export type Issuer = string;
+export type Algorithm = 'RS256' | 'PS256' | 'ES256' | 'EdDSA';
+export type Name = string;
+export interface NodeConnectionProfile {
+    schemaVersion: 1;
+    profile: 'eventsdk-node/1';
+    serviceRef: Ref;
+    installationSource: string;
+    mode: 'DISABLED' | 'SHADOW' | 'ACTIVE';
+    broker: {
+        serverUrl: string;
+        expectedDnsName: Ref;
+        deploymentDomainRef: Ref;
+        credentialsFile: File;
+        authentication: 'NATS_CREDS' | 'NKEY_SEED';
+        caFile?: File;
+        timeoutMs: number;
+        maxPayloadBytes: number;
+    };
+    identity: {
+        originProof: 'eventsdk-origin/1';
+        signer: null | {
+            issuer: Issuer;
+            subject: Ref;
+            keyId: Ref;
+            algorithm: Algorithm;
+            privateKeyFile: File;
+            publicSnapshotFile: File;
+            audiences: [Ref, ...Ref[]];
+            jwksUri: Issuer;
+        };
+        trustedSources: {
+            source: string;
+            serviceRef: Ref;
+            issuer: Issuer;
+            subject: Ref;
+            audience: Ref;
+            algorithms: [Algorithm] | [Algorithm, Algorithm] | [Algorithm, Algorithm, Algorithm] | [Algorithm, Algorithm, Algorithm, Algorithm];
+            jwksUri: Issuer;
+            publicSnapshotFile: File;
+        }[];
+    };
+    publisher: null | {
+        subject: Ref;
+        expectedStream: Name;
+        audienceRoutes?: [
+            {
+                audience: Ref;
+                subject: Ref;
+                expectedStream: Name;
+            },
+            ...{
+                audience: Ref;
+                subject: Ref;
+                expectedStream: Name;
+            }[]
+        ];
+    };
+    consumer: null | {
+        consumerRef: Ref;
+        stream: Name;
+        durableName: Name;
+        subject: Ref;
+        batchSize: number;
+        fetchExpiresMs: number;
+        additionalBindings?: [
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            }
+        ] | [
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            }
+        ] | [
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            }
+        ] | [
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            }
+        ] | [
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            }
+        ] | [
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            }
+        ] | [
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            },
+            {
+                stream: Name;
+                durableName: Name;
+                subject: Ref;
+            }
+        ];
+    };
+}

package/dist/contracts/generated/node-worker-observation.d.ts

@@ -0,0 +1,7 @@
+export interface NodeWorkerObservation {
+    schemaVersion: 1;
+    status: 'DISABLED' | 'CONNECTED' | 'RECONNECTING' | 'STOPPED';
+    connected: boolean;
+    at: string;
+    revision?: string;
+}

package/dist/contracts/generated/outbox-recovery-command.d.ts

@@ -0,0 +1,8 @@
+export interface OutboxRecoveryCommand {
+    schemaVersion: 1;
+    requestId: string;
+    source: string;
+    id: string;
+    deliveryid: string;
+    expectedGeneration: number;
+}