@avenlabs/halal-trace-sdk 0.1.4 → 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.3";
+import { ApiError, request, requestRaw, } from "./http.js";
+const sdkVersion = "0.1.6";
 const withDefaults = (client, options = {}) => {
     return {
         ...options,
@@ -11,7 +11,9 @@ const withDefaults = (client, options = {}) => {
         sdkHeaders: {
             "x-sdk-name": "@avenlabs/halal-trace-sdk",
             "x-sdk-version": sdkVersion,
-            ...(client.clientVersion ? { "x-client-version": client.clientVersion } : {}),
+            ...(client.clientVersion
+                ? { "x-client-version": client.clientVersion }
+                : {}),
             ...(client.userAgent ? { "User-Agent": client.userAgent } : {}),
         },
         hooks: client.hooks,
@@ -23,7 +25,10 @@ async function* listPaginated(client, path, query) {
     const limit = query?.limit ?? 50;
     let offset = 0;
     while (true) {
-        const response = await client.request("GET", path, { query: { ...query, limit, offset }, canRetry: true });
+        const response = await client.request("GET", path, {
+            query: { ...query, limit, offset },
+            canRetry: true,
+        });
         const items = response.body.data ?? [];
         for (const item of items) {
             yield item;
@@ -35,7 +40,10 @@ async function* listPaginated(client, path, query) {
     }
 }
 async function* listSingle(client, path, query) {
-    const response = await client.request("GET", path, { query, canRetry: true });
+    const response = await client.request("GET", path, {
+        query,
+        canRetry: true,
+    });
     const items = response.body.data ?? [];
     for (const item of items) {
         yield item;
@@ -45,7 +53,11 @@ async function* listRelayerJobsAll(client, orgId, query) {
     const limit = query?.limit ?? 100;
     let offset = 0;
     while (true) {
-        const response = await client.orgs.listRelayerJobs(orgId, { ...query, limit, offset });
+        const response = await client.orgs.listRelayerJobs(orgId, {
+            ...query,
+            limit,
+            offset,
+        });
         const items = response.data ?? [];
         for (const item of items) {
             yield item;
@@ -101,13 +113,21 @@ export class ApiClient {
         };
     }
     health = {
-        get: async () => unwrap((await this.request("GET", "/health", { canRetry: true })).body),
-        live: async () => unwrap((await this.request("GET", "/live", { canRetry: true })).body),
-        ready: async () => unwrap((await this.request("GET", "/ready", { canRetry: true })).body),
+        get: async () => unwrap((await this.request("GET", "/health", {
+            canRetry: true,
+        })).body),
+        live: async () => unwrap((await this.request("GET", "/live", { canRetry: true }))
+            .body),
+        ready: async () => unwrap((await this.request("GET", "/ready", {
+            canRetry: true,
+        })).body),
     };
     system = {
         docs: async () => {
-            const response = await requestRaw(this.baseUrl, "/docs", "GET", { ...withDefaults(this, {}), canRetry: true });
+            const response = await requestRaw(this.baseUrl, "/docs", "GET", {
+                ...withDefaults(this, {}),
+                canRetry: true,
+            });
             return response.body;
         },
         openApi: async () => {
@@ -115,7 +135,10 @@ export class ApiClient {
             return response.body;
         },
         metrics: async () => {
-            const response = await requestRaw(this.baseUrl, "/metrics", "GET", { ...withDefaults(this, {}), canRetry: true });
+            const response = await requestRaw(this.baseUrl, "/metrics", "GET", {
+                ...withDefaults(this, {}),
+                canRetry: true,
+            });
             return response.body;
         },
         inviteLanding: async (orgId, token) => {
@@ -134,7 +157,11 @@ export class ApiClient {
                 body: payload,
                 canRetry: false,
             });
-            return { data: response.body, token: response.headers.get("set-auth-token"), requestId: response.requestId };
+            return {
+                data: response.body,
+                token: response.headers.get("set-auth-token"),
+                requestId: response.requestId,
+            };
         },
         signInEmail: async (payload, options) => {
             const response = await requestRaw(this.baseUrl, "/api/auth/sign-in/email", "POST", {
@@ -142,7 +169,11 @@ export class ApiClient {
                 body: payload,
                 canRetry: false,
             });
-            return { data: response.body, token: response.headers.get("set-auth-token"), requestId: response.requestId };
+            return {
+                data: response.body,
+                token: response.headers.get("set-auth-token"),
+                requestId: response.requestId,
+            };
         },
         verifyEmail: async (token, callbackURL) => {
             const response = await requestRaw(this.baseUrl, "/api/auth/verify-email", "GET", {
@@ -150,7 +181,11 @@ export class ApiClient {
                 query: { token, callbackURL },
                 canRetry: true,
             });
-            return { data: response.body, token: response.headers.get("set-auth-token"), requestId: response.requestId };
+            return {
+                data: response.body,
+                token: response.headers.get("set-auth-token"),
+                requestId: response.requestId,
+            };
         },
         requestPasswordReset: async (payload) => {
             const response = await requestRaw(this.baseUrl, "/api/auth/request-password-reset", "POST", {
@@ -158,7 +193,11 @@ export class ApiClient {
                 body: payload,
                 canRetry: false,
             });
-            return { data: response.body, token: response.headers.get("set-auth-token"), requestId: response.requestId };
+            return {
+                data: response.body,
+                token: response.headers.get("set-auth-token"),
+                requestId: response.requestId,
+            };
         },
         resetPassword: async (payload) => {
             const response = await requestRaw(this.baseUrl, "/api/auth/reset-password", "POST", {
@@ -166,10 +205,17 @@ export class ApiClient {
                 body: payload,
                 canRetry: false,
             });
-            return { data: response.body, token: response.headers.get("set-auth-token"), requestId: response.requestId };
+            return {
+                data: response.body,
+                token: response.headers.get("set-auth-token"),
+                requestId: response.requestId,
+            };
         },
     };
     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,
@@ -182,18 +228,38 @@ export class ApiClient {
             canRetry: true,
             idempotencyKey: options?.idempotencyKey,
         }).then((res) => res.body),
-        updateMember: async (orgId, userId, payload) => await this.request("PATCH", `/orgs/${orgId}/members/${userId}`, { body: payload, canRetry: false }).then((res) => res.body),
-        removeMember: async (orgId, userId) => await this.request("DELETE", `/orgs/${orgId}/members/${userId}`, { canRetry: false }).then((res) => res.body),
-        listMembers: async (orgId) => await this.request("GET", `/orgs/${orgId}/members`, { canRetry: true }).then((res) => res.body),
+        updateMember: async (orgId, userId, payload) => await this.request("PATCH", `/orgs/${orgId}/members/${userId}`, {
+            body: payload,
+            canRetry: false,
+        }).then((res) => res.body),
+        removeMember: async (orgId, userId) => await this.request("DELETE", `/orgs/${orgId}/members/${userId}`, {
+            canRetry: false,
+        }).then((res) => res.body),
+        listMembers: async (orgId) => await this.request("GET", `/orgs/${orgId}/members`, {
+            canRetry: true,
+        }).then((res) => res.body),
         listMembersAll: (orgId) => listSingle(this, `/orgs/${orgId}/members`),
-        listAuditLogs: async (orgId, query) => await this.request("GET", `/orgs/${orgId}/audit-logs`, { query, canRetry: true }).then((res) => res.body),
+        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,
+        }).then((res) => res.body),
         listAuditLogsAll: (orgId, query) => listPaginated(this, `/orgs/${orgId}/audit-logs`, query),
         listRelayerJobs: async (orgId, query) => await this.request("GET", `/orgs/${orgId}/relayer-jobs`, { query, canRetry: true }).then((res) => res.body),
         getRelayerJob: async (orgId, jobId) => await this.request("GET", `/orgs/${orgId}/relayer-jobs/${jobId}`, { canRetry: true }).then((res) => res.body),
         listDeadRelayerJobs: async (orgId) => await this.request("GET", `/orgs/${orgId}/relayer-jobs/dead`, { canRetry: true }).then((res) => res.body),
         retryRelayerJob: async (orgId, jobId) => await this.request("POST", `/orgs/${orgId}/relayer-jobs/${jobId}/retry`, { canRetry: false }).then((res) => res.body),
         backfillOrg: async (orgId) => await this.request("POST", `/orgs/${orgId}/relayer-jobs/backfill`, { canRetry: false }).then((res) => res.body),
-        listInvites: async (orgId, query) => await this.request("GET", `/orgs/${orgId}/invites`, { query, canRetry: true }).then((res) => res.body),
+        listInvites: async (orgId, query) => await this.request("GET", `/orgs/${orgId}/invites`, {
+            query,
+            canRetry: true,
+        }).then((res) => res.body),
         listInvitesAll: (orgId, query) => listSingle(this, `/orgs/${orgId}/invites`, query),
         inviteMember: async (orgId, payload, options) => await this.request("POST", `/orgs/${orgId}/invites`, {
             ...options,
@@ -201,10 +267,18 @@ 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),
-        lookupUserByEmail: async (orgId, email) => await this.request("GET", `/orgs/${orgId}/users`, { query: { email }, canRetry: true }).then((res) => res.body),
-        listPermissions: async (orgId) => await this.request("GET", `/orgs/${orgId}/permissions`, { canRetry: true }).then((res) => res.body),
-        addPermission: async (orgId, payload) => await this.request("POST", `/orgs/${orgId}/permissions`, { body: payload, 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,
+        }).then((res) => res.body),
+        listPermissions: async (orgId) => await this.request("GET", `/orgs/${orgId}/permissions`, {
+            canRetry: true,
+        }).then((res) => res.body),
+        addPermission: async (orgId, payload) => await this.request("POST", `/orgs/${orgId}/permissions`, {
+            body: payload,
+            canRetry: false,
+        }).then((res) => res.body),
         removePermission: async (orgId, payload) => await this.request("DELETE", `/orgs/${orgId}/permissions`, {
             body: payload,
             canRetry: false,
@@ -220,7 +294,10 @@ export class ApiClient {
             const start = Date.now();
             while (Date.now() - start < timeoutMs) {
                 const job = await this.relayerJobs.get(orgId, jobId);
-                if (job && (job.status === "completed" || job.status === "dead" || job.status === "failed")) {
+                if (job &&
+                    (job.status === "completed" ||
+                        job.status === "dead" ||
+                        job.status === "failed")) {
                     return job;
                 }
                 await new Promise((resolve) => setTimeout(resolve, intervalMs));
@@ -232,7 +309,11 @@ export class ApiClient {
             const intervalMs = options?.intervalMs ?? 2000;
             const start = Date.now();
             while (Date.now() - start < timeoutMs) {
-                const jobs = await this.orgs.listRelayerJobs(orgId, { requestId, limit: 10, offset: 0 });
+                const jobs = await this.orgs.listRelayerJobs(orgId, {
+                    requestId,
+                    limit: 10,
+                    offset: 0,
+                });
                 const job = jobs.data?.[0];
                 if (job) {
                     return job;
@@ -280,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),
@@ -334,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.4",
+  "version": "0.1.6",
   "private": false,
   "type": "module",
   "main": "dist/index.js",
@@ -18,4 +18,4 @@
     "typescript": "^5.5.4",
     "vitest": "^2.0.4"
   }
-}
+}