@dyrected/sdk 2.5.28 → 2.5.30

package/dist/index.cjs

@@ -250,6 +250,7 @@ COLLECTION OPTIONS:
 - upload: true       \u2014 media library with file upload support
 - auth: true         \u2014 adds login/me endpoints; password field is auto-managed
 - audit: true        \u2014 enables activity logging
+- admin.icon         \u2014 valid Lucide component name for sidebar navigation (e.g. 'Newspaper')
 - admin.useAsTitle   \u2014 field used as display title in admin list view
 - admin.group        \u2014 groups collection under a sidebar heading
 - admin.hidden       \u2014 hides collection from the sidebar (internal/system use)
@@ -292,7 +293,7 @@ const media = defineCollection({
 
 const pages = defineCollection({
   slug: 'pages',
-  admin: { useAsTitle: 'title', group: 'Content' },
+  admin: { icon: 'FileText', useAsTitle: 'title', group: 'Content' },
   fields: [
     { name: 'title', label: 'Title', type: 'text', required: true },
     { name: 'slug',  label: 'URL Slug', type: 'text', required: true, unique: true },
@@ -1103,7 +1104,34 @@ var DyrectedClient = class {
       resetPassword: (token, password) => this.request(`/api/collections/${slug}/reset-password`, {
         method: "POST",
         body: JSON.stringify({ token, password })
-      })
+      }),
+      /**
+       * Perform a workflow transition on a single document.
+       *
+       * @param id - Document ID to transition.
+       * @param transitionName - The transition key (e.g. `'submit'`, `'publish'`, `'reject'`).
+       * @param opts - Optional `expectedRevision` (optimistic concurrency) and `comment`.
+       * @returns The updated document with refreshed `_workflow` metadata.
+       *
+       * @example
+       * // Publisher approves a submission
+       * const updated = await client.collection('posts').transition(id, 'publish')
+       *
+       * // Editor requests changes with a comment
+       * const updated = await client.collection('posts').transition(id, 'reject', {
+       *   expectedRevision: doc._workflow.revision,
+       *   comment: 'Please add more detail to section 2.',
+       * })
+       */
+      transition: (id, transitionName, opts) => this.transition(slug, id, transitionName, opts),
+      /**
+       * Fetch the workflow history for a single document — every transition that
+       * has ever been performed, newest first.
+       *
+       * @param id - Document ID.
+       * @param args - Optional `limit` (default 50, max 100).
+       */
+      workflowHistory: (id, args = {}) => this.workflowHistory(slug, id, args)
     };
   }
   /**
@@ -1152,6 +1180,42 @@ var DyrectedClient = class {
       method: "DELETE"
     });
   }
+  /**
+   * Perform a workflow transition on a document.
+   *
+   * Sends `POST /api/collections/:collection/:id/transitions/:transition`.
+   * Requires the client to have a valid bearer token set via `setToken()`.
+   *
+   * @param collection - Collection slug.
+   * @param id - Document ID.
+   * @param transitionName - Transition key defined in `WorkflowConfig.transitions`.
+   * @param opts - Optional concurrency guard and comment.
+   *
+   * @example
+   * const updated = await client.transition('posts', postId, 'publish')
+   */
+  async transition(collection, id, transitionName, opts = {}) {
+    return this.request(
+      `/api/collections/${collection}/${id}/transitions/${encodeURIComponent(transitionName)}`,
+      {
+        method: "POST",
+        body: JSON.stringify(opts)
+      }
+    );
+  }
+  /**
+   * Fetch the workflow history for a document.
+   *
+   * Sends `GET /api/collections/:collection/:id/workflow-history`.
+   *
+   * @param collection - Collection slug.
+   * @param id - Document ID.
+   * @param args - Optional `limit` (max 100).
+   */
+  async workflowHistory(collection, id, args = {}) {
+    const query = args.limit ? `?limit=${args.limit}` : "";
+    return this.request(`/api/collections/${collection}/${id}/workflow-history${query}`);
+  }
   async deleteMany(collection, ids) {
     return this.request(`/api/collections/${collection}/delete-many`, {
       method: "DELETE",

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { PaginatedResult, FileData, CollectionConfig, GlobalConfig } from '@dyrected/core';
-export { Block, CollectionConfig, Field, FieldType, GlobalConfig, FileData as Media, PaginatedResult } from '@dyrected/core';
+import { PaginatedResult, WorkflowMetadata, FileData, CollectionConfig, GlobalConfig } from '@dyrected/core';
+export { AdminIconName, Block, CollectionConfig, Field, FieldType, GlobalConfig, LifecycleEvent, FileData as Media, PaginatedResult, WorkflowMetadata } from '@dyrected/core';
 
 interface QueryArgs {
     limit?: number;
@@ -36,6 +36,36 @@ interface SetupPromptConfig {
 declare function generateFreshSetupPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
 declare function generateAIPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
 
+/** Shape of a document returned from a workflow-enabled collection. */
+interface WorkflowDocument {
+    id: string;
+    _workflow: WorkflowMetadata;
+    [key: string]: unknown;
+}
+/** Options accepted by `client.transition()`. */
+interface TransitionOptions {
+    /**
+     * The revision number currently shown to the user. When provided, the server
+     * rejects the transition if the document has changed since it was loaded,
+     * preventing lost-update races.
+     */
+    expectedRevision?: number;
+    /** Required for transitions that have `requireComment: true` (e.g. `reject`). */
+    comment?: string;
+}
+/** A single workflow history entry returned by `client.workflowHistory()`. */
+interface WorkflowHistoryEntry {
+    id: string;
+    collection: string;
+    documentId: string;
+    transition: string;
+    from: string;
+    to: string;
+    revision: number;
+    comment: string | null;
+    actorId: string | null;
+    createdAt: string;
+}
 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.
@@ -228,6 +258,35 @@ declare class DyrectedClient<TSchema extends BaseSchema = any> {
             success: boolean;
             message: string;
         }>;
+        /**
+         * Perform a workflow transition on a single document.
+         *
+         * @param id - Document ID to transition.
+         * @param transitionName - The transition key (e.g. `'submit'`, `'publish'`, `'reject'`).
+         * @param opts - Optional `expectedRevision` (optimistic concurrency) and `comment`.
+         * @returns The updated document with refreshed `_workflow` metadata.
+         *
+         * @example
+         * // Publisher approves a submission
+         * const updated = await client.collection('posts').transition(id, 'publish')
+         *
+         * // Editor requests changes with a comment
+         * const updated = await client.collection('posts').transition(id, 'reject', {
+         *   expectedRevision: doc._workflow.revision,
+         *   comment: 'Please add more detail to section 2.',
+         * })
+         */
+        transition: (id: string, transitionName: string, opts?: TransitionOptions) => Promise<TSchema["collections"][K]>;
+        /**
+         * Fetch the workflow history for a single document — every transition that
+         * has ever been performed, newest first.
+         *
+         * @param id - Document ID.
+         * @param args - Optional `limit` (default 50, max 100).
+         */
+        workflowHistory: (id: string, args?: {
+            limit?: number;
+        }) => Promise<PaginatedResult<WorkflowHistoryEntry>>;
     };
     /**
      * Access a global by its slug with a fluent builder.
@@ -250,6 +309,33 @@ declare class DyrectedClient<TSchema extends BaseSchema = any> {
     delete(collection: string, id: string): Promise<{
         message: string;
     }>;
+    /**
+     * Perform a workflow transition on a document.
+     *
+     * Sends `POST /api/collections/:collection/:id/transitions/:transition`.
+     * Requires the client to have a valid bearer token set via `setToken()`.
+     *
+     * @param collection - Collection slug.
+     * @param id - Document ID.
+     * @param transitionName - Transition key defined in `WorkflowConfig.transitions`.
+     * @param opts - Optional concurrency guard and comment.
+     *
+     * @example
+     * const updated = await client.transition('posts', postId, 'publish')
+     */
+    transition<T = WorkflowDocument>(collection: string, id: string, transitionName: string, opts?: TransitionOptions): Promise<T>;
+    /**
+     * Fetch the workflow history for a document.
+     *
+     * Sends `GET /api/collections/:collection/:id/workflow-history`.
+     *
+     * @param collection - Collection slug.
+     * @param id - Document ID.
+     * @param args - Optional `limit` (max 100).
+     */
+    workflowHistory(collection: string, id: string, args?: {
+        limit?: number;
+    }): Promise<PaginatedResult<WorkflowHistoryEntry>>;
     deleteMany(collection: string, ids: string[]): Promise<{
         message: string;
     }>;
@@ -275,4 +361,4 @@ declare function createClient<TSchema extends {
     globals: any;
 } = any>(config: DyrectedClientConfig): DyrectedClient<TSchema>;
 
-export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type SetupPromptConfig, createClient, generateAIPrompt, generateFreshSetupPrompt };
+export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type SetupPromptConfig, type TransitionOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient, generateAIPrompt, generateFreshSetupPrompt };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { PaginatedResult, FileData, CollectionConfig, GlobalConfig } from '@dyrected/core';
-export { Block, CollectionConfig, Field, FieldType, GlobalConfig, FileData as Media, PaginatedResult } from '@dyrected/core';
+import { PaginatedResult, WorkflowMetadata, FileData, CollectionConfig, GlobalConfig } from '@dyrected/core';
+export { AdminIconName, Block, CollectionConfig, Field, FieldType, GlobalConfig, LifecycleEvent, FileData as Media, PaginatedResult, WorkflowMetadata } from '@dyrected/core';
 
 interface QueryArgs {
     limit?: number;
@@ -36,6 +36,36 @@ interface SetupPromptConfig {
 declare function generateFreshSetupPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
 declare function generateAIPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
 
+/** Shape of a document returned from a workflow-enabled collection. */
+interface WorkflowDocument {
+    id: string;
+    _workflow: WorkflowMetadata;
+    [key: string]: unknown;
+}
+/** Options accepted by `client.transition()`. */
+interface TransitionOptions {
+    /**
+     * The revision number currently shown to the user. When provided, the server
+     * rejects the transition if the document has changed since it was loaded,
+     * preventing lost-update races.
+     */
+    expectedRevision?: number;
+    /** Required for transitions that have `requireComment: true` (e.g. `reject`). */
+    comment?: string;
+}
+/** A single workflow history entry returned by `client.workflowHistory()`. */
+interface WorkflowHistoryEntry {
+    id: string;
+    collection: string;
+    documentId: string;
+    transition: string;
+    from: string;
+    to: string;
+    revision: number;
+    comment: string | null;
+    actorId: string | null;
+    createdAt: string;
+}
 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.
@@ -228,6 +258,35 @@ declare class DyrectedClient<TSchema extends BaseSchema = any> {
             success: boolean;
             message: string;
         }>;
+        /**
+         * Perform a workflow transition on a single document.
+         *
+         * @param id - Document ID to transition.
+         * @param transitionName - The transition key (e.g. `'submit'`, `'publish'`, `'reject'`).
+         * @param opts - Optional `expectedRevision` (optimistic concurrency) and `comment`.
+         * @returns The updated document with refreshed `_workflow` metadata.
+         *
+         * @example
+         * // Publisher approves a submission
+         * const updated = await client.collection('posts').transition(id, 'publish')
+         *
+         * // Editor requests changes with a comment
+         * const updated = await client.collection('posts').transition(id, 'reject', {
+         *   expectedRevision: doc._workflow.revision,
+         *   comment: 'Please add more detail to section 2.',
+         * })
+         */
+        transition: (id: string, transitionName: string, opts?: TransitionOptions) => Promise<TSchema["collections"][K]>;
+        /**
+         * Fetch the workflow history for a single document — every transition that
+         * has ever been performed, newest first.
+         *
+         * @param id - Document ID.
+         * @param args - Optional `limit` (default 50, max 100).
+         */
+        workflowHistory: (id: string, args?: {
+            limit?: number;
+        }) => Promise<PaginatedResult<WorkflowHistoryEntry>>;
     };
     /**
      * Access a global by its slug with a fluent builder.
@@ -250,6 +309,33 @@ declare class DyrectedClient<TSchema extends BaseSchema = any> {
     delete(collection: string, id: string): Promise<{
         message: string;
     }>;
+    /**
+     * Perform a workflow transition on a document.
+     *
+     * Sends `POST /api/collections/:collection/:id/transitions/:transition`.
+     * Requires the client to have a valid bearer token set via `setToken()`.
+     *
+     * @param collection - Collection slug.
+     * @param id - Document ID.
+     * @param transitionName - Transition key defined in `WorkflowConfig.transitions`.
+     * @param opts - Optional concurrency guard and comment.
+     *
+     * @example
+     * const updated = await client.transition('posts', postId, 'publish')
+     */
+    transition<T = WorkflowDocument>(collection: string, id: string, transitionName: string, opts?: TransitionOptions): Promise<T>;
+    /**
+     * Fetch the workflow history for a document.
+     *
+     * Sends `GET /api/collections/:collection/:id/workflow-history`.
+     *
+     * @param collection - Collection slug.
+     * @param id - Document ID.
+     * @param args - Optional `limit` (max 100).
+     */
+    workflowHistory(collection: string, id: string, args?: {
+        limit?: number;
+    }): Promise<PaginatedResult<WorkflowHistoryEntry>>;
     deleteMany(collection: string, ids: string[]): Promise<{
         message: string;
     }>;
@@ -275,4 +361,4 @@ declare function createClient<TSchema extends {
     globals: any;
 } = any>(config: DyrectedClientConfig): DyrectedClient<TSchema>;
 
-export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type SetupPromptConfig, createClient, generateAIPrompt, generateFreshSetupPrompt };
+export { type BaseSchema, DyrectedClient, type DyrectedClientConfig, DyrectedError, type InferSchema, type SetupPromptConfig, type TransitionOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient, generateAIPrompt, generateFreshSetupPrompt };

package/dist/index.js

@@ -220,6 +220,7 @@ COLLECTION OPTIONS:
 - upload: true       \u2014 media library with file upload support
 - auth: true         \u2014 adds login/me endpoints; password field is auto-managed
 - audit: true        \u2014 enables activity logging
+- admin.icon         \u2014 valid Lucide component name for sidebar navigation (e.g. 'Newspaper')
 - admin.useAsTitle   \u2014 field used as display title in admin list view
 - admin.group        \u2014 groups collection under a sidebar heading
 - admin.hidden       \u2014 hides collection from the sidebar (internal/system use)
@@ -262,7 +263,7 @@ const media = defineCollection({
 
 const pages = defineCollection({
   slug: 'pages',
-  admin: { useAsTitle: 'title', group: 'Content' },
+  admin: { icon: 'FileText', useAsTitle: 'title', group: 'Content' },
   fields: [
     { name: 'title', label: 'Title', type: 'text', required: true },
     { name: 'slug',  label: 'URL Slug', type: 'text', required: true, unique: true },
@@ -1073,7 +1074,34 @@ var DyrectedClient = class {
       resetPassword: (token, password) => this.request(`/api/collections/${slug}/reset-password`, {
         method: "POST",
         body: JSON.stringify({ token, password })
-      })
+      }),
+      /**
+       * Perform a workflow transition on a single document.
+       *
+       * @param id - Document ID to transition.
+       * @param transitionName - The transition key (e.g. `'submit'`, `'publish'`, `'reject'`).
+       * @param opts - Optional `expectedRevision` (optimistic concurrency) and `comment`.
+       * @returns The updated document with refreshed `_workflow` metadata.
+       *
+       * @example
+       * // Publisher approves a submission
+       * const updated = await client.collection('posts').transition(id, 'publish')
+       *
+       * // Editor requests changes with a comment
+       * const updated = await client.collection('posts').transition(id, 'reject', {
+       *   expectedRevision: doc._workflow.revision,
+       *   comment: 'Please add more detail to section 2.',
+       * })
+       */
+      transition: (id, transitionName, opts) => this.transition(slug, id, transitionName, opts),
+      /**
+       * Fetch the workflow history for a single document — every transition that
+       * has ever been performed, newest first.
+       *
+       * @param id - Document ID.
+       * @param args - Optional `limit` (default 50, max 100).
+       */
+      workflowHistory: (id, args = {}) => this.workflowHistory(slug, id, args)
     };
   }
   /**
@@ -1122,6 +1150,42 @@ var DyrectedClient = class {
       method: "DELETE"
     });
   }
+  /**
+   * Perform a workflow transition on a document.
+   *
+   * Sends `POST /api/collections/:collection/:id/transitions/:transition`.
+   * Requires the client to have a valid bearer token set via `setToken()`.
+   *
+   * @param collection - Collection slug.
+   * @param id - Document ID.
+   * @param transitionName - Transition key defined in `WorkflowConfig.transitions`.
+   * @param opts - Optional concurrency guard and comment.
+   *
+   * @example
+   * const updated = await client.transition('posts', postId, 'publish')
+   */
+  async transition(collection, id, transitionName, opts = {}) {
+    return this.request(
+      `/api/collections/${collection}/${id}/transitions/${encodeURIComponent(transitionName)}`,
+      {
+        method: "POST",
+        body: JSON.stringify(opts)
+      }
+    );
+  }
+  /**
+   * Fetch the workflow history for a document.
+   *
+   * Sends `GET /api/collections/:collection/:id/workflow-history`.
+   *
+   * @param collection - Collection slug.
+   * @param id - Document ID.
+   * @param args - Optional `limit` (max 100).
+   */
+  async workflowHistory(collection, id, args = {}) {
+    const query = args.limit ? `?limit=${args.limit}` : "";
+    return this.request(`/api/collections/${collection}/${id}/workflow-history${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.28",
+  "version": "2.5.30",
   "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.28"
+    "@dyrected/core": "2.5.30"
   },
   "license": "BSL-1.1",
   "author": "Busola Okeowo <busolaokemoney@gmail.com>",