@avenlabs/halal-trace-sdk 0.1.5 → 0.1.6

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { Anchor, AuditLog, AuditPack, AuditPackManifest, AuthResult, Batch, CertificationRecord, Device, DocumentAnchor, EventDepartment, HealthResponse, Hologram, HologramVerification, Invite, Member, Org, OrgInviteResult, OrgUserLookup, Permission, PublicAttribute, RelayerJobSummary, SignatureRecord, TraceEvent } from "./types.js";
+import type { Anchor, AuditLog, AuditPack, AuditPackWithBatch, AuditPackManifest, AuthResult, Batch, BatchTrace, CertificationRecord, Device, DocumentAnchor, EventDepartment, HealthResponse, Hologram, HologramVerification, Invite, InviteAcceptance, AccessRequest, Member, Org, OrgSummary, OrgInviteResult, OrgUserLookup, Permission, PublicAttribute, RelayerJobSummary, SignatureRecord, TraceEvent } from "./types.js";
 import { ApiError, type AuthOptions, type ClientHooks, type RequestOptions, type RetryOptions } from "./http.js";
 type BaseClientOptions = {
     baseUrl: string;
@@ -74,6 +74,24 @@ export declare class ApiClient {
         }) => Promise<AuthResult>;
     };
     orgs: {
+        list: () => Promise<{
+            requestId: string;
+            status: import("./types.js").ApiStatus;
+            data?: Org[] | undefined;
+            relayerJob?: RelayerJobSummary | null;
+        }>;
+        get: (orgId: string) => Promise<{
+            requestId: string;
+            status: import("./types.js").ApiStatus;
+            data?: Org | undefined;
+            relayerJob?: RelayerJobSummary | null;
+        }>;
+        getSummary: (orgId: string) => Promise<{
+            requestId: string;
+            status: import("./types.js").ApiStatus;
+            data?: OrgSummary | undefined;
+            relayerJob?: RelayerJobSummary | null;
+        }>;
         create: (payload: {
             orgId: string;
             name?: string;
@@ -115,6 +133,42 @@ export declare class ApiClient {
             relayerJob?: RelayerJobSummary | null;
         }>;
         listMembersAll: (orgId: string) => AsyncGenerator<Member, void, unknown>;
+        listBatches: (orgId: string, query?: {
+            limit?: number;
+            offset?: number;
+        }) => Promise<{
+            requestId: string;
+            status: import("./types.js").ApiStatus;
+            data?: Batch[] | undefined;
+            relayerJob?: RelayerJobSummary | null;
+        }>;
+        listDevices: (orgId: string, query?: {
+            limit?: number;
+            offset?: number;
+        }) => Promise<{
+            requestId: string;
+            status: import("./types.js").ApiStatus;
+            data?: Device[] | undefined;
+            relayerJob?: RelayerJobSummary | null;
+        }>;
+        listHolograms: (orgId: string, query?: {
+            limit?: number;
+            offset?: number;
+        }) => Promise<{
+            requestId: string;
+            status: import("./types.js").ApiStatus;
+            data?: Hologram[] | undefined;
+            relayerJob?: RelayerJobSummary | null;
+        }>;
+        listAuditPacks: (orgId: string, query?: {
+            limit?: number;
+            offset?: number;
+        }) => Promise<{
+            requestId: string;
+            status: import("./types.js").ApiStatus;
+            data?: AuditPackWithBatch[] | undefined;
+            relayerJob?: RelayerJobSummary | null;
+        }>;
         listAuditLogs: (orgId: string, query?: {
             limit?: number;
             offset?: number;
@@ -186,13 +240,14 @@ export declare class ApiClient {
             data?: OrgInviteResult | undefined;
             relayerJob?: RelayerJobSummary | null;
         }>;
-        acceptInvite: (orgId: string, token: string) => Promise<{
+        acceptInvite: (orgId: string, token: string, payload?: {
+            name?: string;
+            password?: string;
+            callbackURL?: string;
+        }) => Promise<{
             requestId: string;
             status: import("./types.js").ApiStatus;
-            data?: {
-                invite: Invite;
-                member: Member;
-            } | undefined;
+            data?: InviteAcceptance | undefined;
             relayerJob?: RelayerJobSummary | null;
         }>;
         lookupUserByEmail: (orgId: string, email: string) => Promise<{
@@ -325,6 +380,15 @@ export declare class ApiClient {
             data?: AuditPackManifest | undefined;
             relayerJob?: RelayerJobSummary | null;
         }>;
+        getTrace: (batchId: string, query?: {
+            include?: string;
+            eventType?: string;
+        }) => Promise<{
+            requestId: string;
+            status: import("./types.js").ApiStatus;
+            data?: BatchTrace | undefined;
+            relayerJob?: RelayerJobSummary | null;
+        }>;
         listRelayerJobs: (batchId: string, query?: {
             status?: string;
             jobType?: string;
@@ -411,6 +475,33 @@ export declare class ApiClient {
         downloadPdf: (pdfUri: string) => Promise<ArrayBuffer>;
         downloadJson: (jsonUri: string) => Promise<string>;
     };
+    accessRequests: {
+        create: (payload: {
+            companyName: string;
+            adminEmail: string;
+            companyDomain: string;
+            headcountEstimate?: number;
+        }) => Promise<{
+            requestId: string;
+            status: import("./types.js").ApiStatus;
+            data?: AccessRequest | undefined;
+            relayerJob?: RelayerJobSummary | null;
+        }>;
+        approve: (id: number, payload?: {
+            orgId?: string;
+            orgName?: string;
+            inviteUrl?: string;
+        }) => Promise<{
+            requestId: string;
+            status: import("./types.js").ApiStatus;
+            data?: {
+                lead: AccessRequest;
+                org: Org;
+                invite: Invite;
+            } | undefined;
+            relayerJob?: RelayerJobSummary | null;
+        }>;
+    };
     holograms: {
         issue: (payload: {
             batchId: string;

package/dist/client.js

@@ -1,5 +1,5 @@
 import { ApiError, request, requestRaw, } from "./http.js";
-const sdkVersion = "0.1.5";
+const sdkVersion = "0.1.6";
 const withDefaults = (client, options = {}) => {
     return {
         ...options,
@@ -213,6 +213,9 @@ export class ApiClient {
         },
     };
     orgs = {
+        list: async () => await this.request("GET", "/orgs", { canRetry: true }).then((res) => res.body),
+        get: async (orgId) => await this.request("GET", `/orgs/${orgId}`, { canRetry: true }).then((res) => res.body),
+        getSummary: async (orgId) => await this.request("GET", `/orgs/${orgId}/summary`, { canRetry: true }).then((res) => res.body),
         create: async (payload, options) => await this.request("POST", "/orgs", {
             ...options,
             body: payload,
@@ -236,6 +239,13 @@ export class ApiClient {
             canRetry: true,
         }).then((res) => res.body),
         listMembersAll: (orgId) => listSingle(this, `/orgs/${orgId}/members`),
+        listBatches: async (orgId, query) => await this.request("GET", `/orgs/${orgId}/batches`, { query, canRetry: true }).then((res) => res.body),
+        listDevices: async (orgId, query) => await this.request("GET", `/orgs/${orgId}/devices`, { query, canRetry: true }).then((res) => res.body),
+        listHolograms: async (orgId, query) => await this.request("GET", `/orgs/${orgId}/holograms`, { query, canRetry: true }).then((res) => res.body),
+        listAuditPacks: async (orgId, query) => await this.request("GET", `/orgs/${orgId}/audit-packs`, {
+            query,
+            canRetry: true,
+        }).then((res) => res.body),
         listAuditLogs: async (orgId, query) => await this.request("GET", `/orgs/${orgId}/audit-logs`, {
             query,
             canRetry: true,
@@ -257,7 +267,7 @@ export class ApiClient {
             canRetry: true,
             idempotencyKey: options?.idempotencyKey,
         }).then((res) => res.body),
-        acceptInvite: async (orgId, token) => await this.request("POST", `/orgs/${orgId}/invites/${token}/accept`, { canRetry: false }).then((res) => res.body),
+        acceptInvite: async (orgId, token, payload) => await this.request("POST", `/orgs/${orgId}/invites/${token}/accept`, { body: payload, canRetry: false }).then((res) => res.body),
         lookupUserByEmail: async (orgId, email) => await this.request("GET", `/orgs/${orgId}/users`, {
             query: { email },
             canRetry: true,
@@ -351,6 +361,7 @@ export class ApiClient {
             idempotencyKey: options?.idempotencyKey,
         }).then((res) => res.body),
         getAuditPackManifest: async (batchId) => await this.request("GET", `/batches/${batchId}/audit-pack/manifest`, { canRetry: true }).then((res) => res.body),
+        getTrace: async (batchId, query) => await this.request("GET", `/batches/${batchId}/trace`, { query, canRetry: true }).then((res) => res.body),
         listRelayerJobs: async (batchId, query) => await this.request("GET", `/batches/${batchId}/relayer-jobs`, { query, canRetry: true }).then((res) => res.body),
         listRelayerJobsAll: (batchId, query) => listPaginated(this, `/batches/${batchId}/relayer-jobs`, query),
         backfillBatch: async (batchId) => await this.request("POST", `/batches/${batchId}/relayer-jobs/backfill`, { canRetry: false }).then((res) => res.body),
@@ -405,6 +416,13 @@ export class ApiClient {
             return response.text();
         },
     };
+    accessRequests = {
+        create: async (payload) => await this.request("POST", "/access-requests", {
+            body: payload,
+            canRetry: false,
+        }).then((res) => res.body),
+        approve: async (id, payload) => await this.request("POST", `/access-requests/${id}/approve`, { body: payload, canRetry: false }).then((res) => res.body),
+    };
     holograms = {
         issue: async (payload, options) => await this.request("POST", "/holograms", {
             ...options,

package/dist/types.d.ts

@@ -20,10 +20,33 @@ export type RelayerJobSummary = {
 export type Org = {
     orgId: string;
     name?: string | null;
-    adminId: string;
+    adminId?: string | null;
     active?: boolean;
+    status?: string;
+    invitePolicy?: string;
+    allowlistedDomains?: string;
     createdAt?: string;
 };
+export type OrgSummary = {
+    orgId: string;
+    batchesTotal: number;
+    batchesActive: number;
+    devicesTotal: number;
+    devicesActive: number;
+    membersTotal: number;
+    hologramsTotal: number;
+    auditPacksTotal: number;
+    relayerJobs: {
+        pending: number;
+        processing: number;
+        completed: number;
+        failed: number;
+        dead: number;
+    };
+};
+export type AuditPackWithBatch = AuditPack & {
+    batch: Batch;
+};
 export type Batch = {
     batchId: string;
     orgId: string;
@@ -120,6 +143,52 @@ export type AuditPackManifest = {
     auditPack: AuditPack;
     publicAttributes: PublicAttribute[];
 };
+export type TraceTimelineItem = {
+    kind: "event";
+    id: number;
+    recordedAt: string;
+    eventType: string;
+    metadataHash: string;
+    actorRole: string;
+    deviceId?: string | null;
+} | {
+    kind: "document";
+    id: number;
+    recordedAt: string;
+    docType: string;
+    docHash: string;
+    uri: string;
+} | {
+    kind: "signature";
+    id: number;
+    recordedAt: string;
+    signerRole: string;
+    signatureHash: string;
+    signerIdHash: string;
+} | {
+    kind: "certification";
+    id: number;
+    recordedAt: string;
+    status: "pending" | "approved" | "rejected";
+    decisionHash: string;
+    reviewerRole: string;
+    reviewerIdHash: string;
+} | {
+    kind: "public_attribute";
+    id: number;
+    recordedAt: string;
+    key: string;
+    value: string;
+};
+export type BatchTrace = {
+    batch: Batch;
+    timeline: TraceTimelineItem[];
+    events: TraceEvent[];
+    documents: DocumentAnchor[];
+    signatures: SignatureRecord[];
+    certifications: CertificationRecord[];
+    publicAttributes: PublicAttribute[];
+};
 export type HologramVerification = {
     hologramId: string;
     publicCode: string;
@@ -161,10 +230,28 @@ export type Invite = {
     role: string;
     department: string;
     status: string;
-    invitedBy: string;
+    invitedBy?: string | null;
     createdAt: string;
     expiresAt: string;
     acceptedAt?: string | null;
+    tokenHash?: string | null;
+    usedAt?: string | null;
+};
+export type InviteAcceptance = {
+    invite: Invite;
+    member: Member;
+    mode?: "accepted" | "signup";
+};
+export type AccessRequest = {
+    id: number;
+    companyName: string;
+    adminEmail: string;
+    companyDomain: string;
+    headcountEstimate?: number | null;
+    status: string;
+    approvedBy?: string | null;
+    approvedAt?: string | null;
+    createdAt: string;
 };
 export type Permission = {
     orgId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avenlabs/halal-trace-sdk",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "private": false,
   "type": "module",
   "main": "dist/index.js",
@@ -18,4 +18,4 @@
     "typescript": "^5.5.4",
     "vitest": "^2.0.4"
   }
-}
+}

package/src/client.ts

@@ -3,9 +3,11 @@ import type {
   ApiResponse,
   AuditLog,
   AuditPack,
+  AuditPackWithBatch,
   AuditPackManifest,
   AuthResult,
   Batch,
+  BatchTrace,
   CertificationRecord,
   Device,
   DocumentAnchor,
@@ -14,8 +16,11 @@ import type {
   Hologram,
   HologramVerification,
   Invite,
+  InviteAcceptance,
+  AccessRequest,
   Member,
   Org,
+  OrgSummary,
   OrgInviteResult,
   OrgUserLookup,
   Permission,
@@ -59,7 +64,7 @@ type RequestConfig = Omit<
   onAuthError?: (error: ApiError) => void | Promise<void>;
 };
 
-const sdkVersion = "0.1.5";
+const sdkVersion = "0.1.6";
 
 const withDefaults = (
   client: ApiClient,
@@ -378,6 +383,12 @@ export class ApiClient {
   };
 
   orgs = {
+    list: async () =>
+      await this.request<Org[]>("GET", "/orgs", { canRetry: true }).then((res) => res.body),
+    get: async (orgId: string) =>
+      await this.request<Org>("GET", `/orgs/${orgId}`, { canRetry: true }).then((res) => res.body),
+    getSummary: async (orgId: string) =>
+      await this.request<OrgSummary>("GET", `/orgs/${orgId}/summary`, { canRetry: true }).then((res) => res.body),
     create: async (
       payload: { orgId: string; name?: string },
       options?: RequestConfig,
@@ -418,6 +429,17 @@ export class ApiClient {
       }).then((res) => res.body),
     listMembersAll: (orgId: string) =>
       listSingle<Member>(this, `/orgs/${orgId}/members`),
+    listBatches: async (orgId: string, query?: { limit?: number; offset?: number }) =>
+      await this.request<Batch[]>("GET", `/orgs/${orgId}/batches`, { query, canRetry: true }).then((res) => res.body),
+    listDevices: async (orgId: string, query?: { limit?: number; offset?: number }) =>
+      await this.request<Device[]>("GET", `/orgs/${orgId}/devices`, { query, canRetry: true }).then((res) => res.body),
+    listHolograms: async (orgId: string, query?: { limit?: number; offset?: number }) =>
+      await this.request<Hologram[]>("GET", `/orgs/${orgId}/holograms`, { query, canRetry: true }).then((res) => res.body),
+    listAuditPacks: async (orgId: string, query?: { limit?: number; offset?: number }) =>
+      await this.request<AuditPackWithBatch[]>("GET", `/orgs/${orgId}/audit-packs`, {
+        query,
+        canRetry: true,
+      }).then((res) => res.body),
     listAuditLogs: async (
       orgId: string,
       query?: { limit?: number; offset?: number },
@@ -491,11 +513,15 @@ export class ApiClient {
         canRetry: true,
         idempotencyKey: options?.idempotencyKey,
       }).then((res) => res.body),
-    acceptInvite: async (orgId: string, token: string) =>
-      await this.request<{ invite: Invite; member: Member }>(
+    acceptInvite: async (
+      orgId: string,
+      token: string,
+      payload?: { name?: string; password?: string; callbackURL?: string },
+    ) =>
+      await this.request<InviteAcceptance>(
         "POST",
         `/orgs/${orgId}/invites/${token}/accept`,
-        { canRetry: false },
+        { body: payload, canRetry: false },
       ).then((res) => res.body),
     lookupUserByEmail: async (orgId: string, email: string) =>
       await this.request<OrgUserLookup>("GET", `/orgs/${orgId}/users`, {
@@ -702,6 +728,12 @@ export class ApiClient {
         `/batches/${batchId}/audit-pack/manifest`,
         { canRetry: true },
       ).then((res) => res.body),
+    getTrace: async (batchId: string, query?: { include?: string; eventType?: string }) =>
+      await this.request<BatchTrace>(
+        "GET",
+        `/batches/${batchId}/trace`,
+        { query, canRetry: true },
+      ).then((res) => res.body),
     listRelayerJobs: async (
       batchId: string,
       query?: {
@@ -834,6 +866,28 @@ export class ApiClient {
     },
   };
 
+  accessRequests = {
+    create: async (payload: {
+      companyName: string;
+      adminEmail: string;
+      companyDomain: string;
+      headcountEstimate?: number;
+    }) =>
+      await this.request<AccessRequest>("POST", "/access-requests", {
+        body: payload,
+        canRetry: false,
+      }).then((res) => res.body),
+    approve: async (
+      id: number,
+      payload?: { orgId?: string; orgName?: string; inviteUrl?: string },
+    ) =>
+      await this.request<{ lead: AccessRequest; org: Org; invite: Invite }>(
+        "POST",
+        `/access-requests/${id}/approve`,
+        { body: payload, canRetry: false },
+      ).then((res) => res.body),
+  };
+
   holograms = {
     issue: async (
       payload: {

package/src/types.ts

@@ -24,11 +24,34 @@ export type RelayerJobSummary = {
 export type Org = {
   orgId: string;
   name?: string | null;
-  adminId: string;
+  adminId?: string | null;
   active?: boolean;
+  status?: string;
+  invitePolicy?: string;
+  allowlistedDomains?: string;
   createdAt?: string;
 };
 
+export type OrgSummary = {
+  orgId: string;
+  batchesTotal: number;
+  batchesActive: number;
+  devicesTotal: number;
+  devicesActive: number;
+  membersTotal: number;
+  hologramsTotal: number;
+  auditPacksTotal: number;
+  relayerJobs: {
+    pending: number;
+    processing: number;
+    completed: number;
+    failed: number;
+    dead: number;
+  };
+};
+
+export type AuditPackWithBatch = AuditPack & { batch: Batch };
+
 export type Batch = {
   batchId: string;
   orgId: string;
@@ -136,6 +159,59 @@ export type AuditPackManifest = {
   publicAttributes: PublicAttribute[];
 };
 
+export type TraceTimelineItem =
+  | {
+      kind: "event";
+      id: number;
+      recordedAt: string;
+      eventType: string;
+      metadataHash: string;
+      actorRole: string;
+      deviceId?: string | null;
+    }
+  | {
+      kind: "document";
+      id: number;
+      recordedAt: string;
+      docType: string;
+      docHash: string;
+      uri: string;
+    }
+  | {
+      kind: "signature";
+      id: number;
+      recordedAt: string;
+      signerRole: string;
+      signatureHash: string;
+      signerIdHash: string;
+    }
+  | {
+      kind: "certification";
+      id: number;
+      recordedAt: string;
+      status: "pending" | "approved" | "rejected";
+      decisionHash: string;
+      reviewerRole: string;
+      reviewerIdHash: string;
+    }
+  | {
+      kind: "public_attribute";
+      id: number;
+      recordedAt: string;
+      key: string;
+      value: string;
+    };
+
+export type BatchTrace = {
+  batch: Batch;
+  timeline: TraceTimelineItem[];
+  events: TraceEvent[];
+  documents: DocumentAnchor[];
+  signatures: SignatureRecord[];
+  certifications: CertificationRecord[];
+  publicAttributes: PublicAttribute[];
+};
+
 export type HologramVerification = {
   hologramId: string;
   publicCode: string;
@@ -180,10 +256,30 @@ export type Invite = {
   role: string;
   department: string;
   status: string;
-  invitedBy: string;
+  invitedBy?: string | null;
   createdAt: string;
   expiresAt: string;
   acceptedAt?: string | null;
+  tokenHash?: string | null;
+  usedAt?: string | null;
+};
+
+export type InviteAcceptance = {
+  invite: Invite;
+  member: Member;
+  mode?: "accepted" | "signup";
+};
+
+export type AccessRequest = {
+  id: number;
+  companyName: string;
+  adminEmail: string;
+  companyDomain: string;
+  headcountEstimate?: number | null;
+  status: string;
+  approvedBy?: string | null;
+  approvedAt?: string | null;
+  createdAt: string;
 };
 
 export type Permission = {