@dyrected/sdk 2.5.59 → 2.5.60

package/dist/index.cjs

@@ -340,7 +340,13 @@ var DyrectedClient = class {
        * @param id - Document ID.
        * @param args - Optional `limit` (default 50, max 100).
        */
-      workflowHistory: (id, args = {}) => this.workflowHistory(slug, id, args)
+      workflowHistory: (id, args = {}) => this.workflowHistory(slug, id, args),
+      /**
+       * Fetch audit entries for this collection.
+       *
+       * Sends `GET /api/collections/:collection/__audit`.
+       */
+      audit: (args = {}) => this.collectionAudit(slug, args)
     };
   }
   /**
@@ -422,6 +428,24 @@ var DyrectedClient = class {
     const query = args.limit ? `?limit=${args.limit}` : "";
     return this.request(`/api/collections/${collection}/${id}/workflow-history${query}`);
   }
+  /**
+   * Fetch audit entries across every audited collection the current caller can read.
+   *
+   * Sends `GET /api/audit`.
+   */
+  async audit(args = {}) {
+    const query = stringifyQuery(normalizeQueryArgs(args), { addQueryPrefix: true });
+    return this.request(`/api/audit${query}`);
+  }
+  /**
+   * Fetch audit entries for a single collection.
+   *
+   * Sends `GET /api/collections/:collection/__audit`.
+   */
+  async collectionAudit(collection, args = {}) {
+    const query = stringifyQuery(normalizeQueryArgs(args), { addQueryPrefix: true });
+    return this.request(`/api/collections/${collection}/__audit${query}`);
+  }
   async deleteMany(collection, ids) {
     return this.request(`/api/collections/${collection}/delete-many`, {
       method: "DELETE",

package/dist/index.d.cts

@@ -63,6 +63,16 @@ interface WorkflowHistoryEntry {
     actorId: string | null;
     createdAt: string;
 }
+/** A single audit entry returned by `client.audit()` or `client.collection(slug).audit()`. */
+interface AuditEntry {
+    id: string;
+    collection: string;
+    documentId: string | null;
+    operation: string;
+    user: string | null;
+    timestamp: string;
+    changes?: string | Record<string, unknown> | null;
+}
 type ExtractDoc<T> = T extends CollectionConfig<infer TDoc> ? TDoc : T extends GlobalConfig<infer TDoc> ? TDoc : never;
 /**
  * Derives a typed `TSchema` from your exported collection and global config constants.
@@ -309,6 +319,12 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
         workflowHistory: (id: string, args?: {
             limit?: number;
         }) => Promise<PaginatedResult<WorkflowHistoryEntry>>;
+        /**
+         * Fetch audit entries for this collection.
+         *
+         * Sends `GET /api/collections/:collection/__audit`.
+         */
+        audit: (args?: QueryArgs<AuditEntry>) => Promise<PaginatedResult<AuditEntry>>;
     };
     /**
      * Access a global by its slug with a fluent builder.
@@ -358,6 +374,18 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
     workflowHistory(collection: string, id: string, args?: {
         limit?: number;
     }): Promise<PaginatedResult<WorkflowHistoryEntry>>;
+    /**
+     * Fetch audit entries across every audited collection the current caller can read.
+     *
+     * Sends `GET /api/audit`.
+     */
+    audit(args?: QueryArgs<AuditEntry>): Promise<PaginatedResult<AuditEntry>>;
+    /**
+     * Fetch audit entries for a single collection.
+     *
+     * Sends `GET /api/collections/:collection/__audit`.
+     */
+    collectionAudit(collection: string, args?: QueryArgs<AuditEntry>): Promise<PaginatedResult<AuditEntry>>;
     deleteMany(collection: string, ids: string[]): Promise<{
         message: string;
     }>;
@@ -386,4 +414,4 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
 }
 declare function createClient<TSchema extends BaseSchema = BaseSchema>(config: DyrectedClientConfig): DyrectedClient<TSchema>;
 
-export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type TransitionOptions, type UploadOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };
+export { type AuditEntry, type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type TransitionOptions, type UploadOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };

package/dist/index.d.ts

@@ -63,6 +63,16 @@ interface WorkflowHistoryEntry {
     actorId: string | null;
     createdAt: string;
 }
+/** A single audit entry returned by `client.audit()` or `client.collection(slug).audit()`. */
+interface AuditEntry {
+    id: string;
+    collection: string;
+    documentId: string | null;
+    operation: string;
+    user: string | null;
+    timestamp: string;
+    changes?: string | Record<string, unknown> | null;
+}
 type ExtractDoc<T> = T extends CollectionConfig<infer TDoc> ? TDoc : T extends GlobalConfig<infer TDoc> ? TDoc : never;
 /**
  * Derives a typed `TSchema` from your exported collection and global config constants.
@@ -309,6 +319,12 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
         workflowHistory: (id: string, args?: {
             limit?: number;
         }) => Promise<PaginatedResult<WorkflowHistoryEntry>>;
+        /**
+         * Fetch audit entries for this collection.
+         *
+         * Sends `GET /api/collections/:collection/__audit`.
+         */
+        audit: (args?: QueryArgs<AuditEntry>) => Promise<PaginatedResult<AuditEntry>>;
     };
     /**
      * Access a global by its slug with a fluent builder.
@@ -358,6 +374,18 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
     workflowHistory(collection: string, id: string, args?: {
         limit?: number;
     }): Promise<PaginatedResult<WorkflowHistoryEntry>>;
+    /**
+     * Fetch audit entries across every audited collection the current caller can read.
+     *
+     * Sends `GET /api/audit`.
+     */
+    audit(args?: QueryArgs<AuditEntry>): Promise<PaginatedResult<AuditEntry>>;
+    /**
+     * Fetch audit entries for a single collection.
+     *
+     * Sends `GET /api/collections/:collection/__audit`.
+     */
+    collectionAudit(collection: string, args?: QueryArgs<AuditEntry>): Promise<PaginatedResult<AuditEntry>>;
     deleteMany(collection: string, ids: string[]): Promise<{
         message: string;
     }>;
@@ -386,4 +414,4 @@ declare class DyrectedClient<TSchema extends BaseSchema = BaseSchema> {
 }
 declare function createClient<TSchema extends BaseSchema = BaseSchema>(config: DyrectedClientConfig): DyrectedClient<TSchema>;
 
-export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type TransitionOptions, type UploadOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };
+export { type AuditEntry, type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type TransitionOptions, type UploadOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };

package/dist/index.js

@@ -312,7 +312,13 @@ var DyrectedClient = class {
        * @param id - Document ID.
        * @param args - Optional `limit` (default 50, max 100).
        */
-      workflowHistory: (id, args = {}) => this.workflowHistory(slug, id, args)
+      workflowHistory: (id, args = {}) => this.workflowHistory(slug, id, args),
+      /**
+       * Fetch audit entries for this collection.
+       *
+       * Sends `GET /api/collections/:collection/__audit`.
+       */
+      audit: (args = {}) => this.collectionAudit(slug, args)
     };
   }
   /**
@@ -394,6 +400,24 @@ var DyrectedClient = class {
     const query = args.limit ? `?limit=${args.limit}` : "";
     return this.request(`/api/collections/${collection}/${id}/workflow-history${query}`);
   }
+  /**
+   * Fetch audit entries across every audited collection the current caller can read.
+   *
+   * Sends `GET /api/audit`.
+   */
+  async audit(args = {}) {
+    const query = stringifyQuery(normalizeQueryArgs(args), { addQueryPrefix: true });
+    return this.request(`/api/audit${query}`);
+  }
+  /**
+   * Fetch audit entries for a single collection.
+   *
+   * Sends `GET /api/collections/:collection/__audit`.
+   */
+  async collectionAudit(collection, args = {}) {
+    const query = stringifyQuery(normalizeQueryArgs(args), { addQueryPrefix: true });
+    return this.request(`/api/collections/${collection}/__audit${query}`);
+  }
   async deleteMany(collection, ids) {
     return this.request(`/api/collections/${collection}/delete-many`, {
       method: "DELETE",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dyrected/sdk",
-  "version": "2.5.59",
+  "version": "2.5.60",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -30,7 +30,7 @@
     "tsup": "^8.5.1",
     "typescript": "^5.4.5",
     "vitest": "^1.0.0",
-    "@dyrected/core": "2.5.59"
+    "@dyrected/core": "2.5.60"
   },
   "license": "BSL-1.1",
   "author": "Busola Okeowo <busolaokemoney@gmail.com>",