@dyrected/sdk 2.5.29 → 2.5.32

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;
@@ -24,18 +24,36 @@ declare class QueryBuilder<T = any> {
     then<TResult1 = PaginatedResult<T>, TResult2 = never>(onfulfilled?: ((value: PaginatedResult<T>) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
 }
 
-interface SetupPromptConfig {
-    siteName?: string;
-    siteId?: string;
-    apiKey?: string;
-    baseUrl?: string;
-    isSelfHosted?: boolean;
-    existingSite?: boolean;
-    defaultTechStack?: 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;
 }
-declare function generateFreshSetupPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
-declare function generateAIPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): 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 +246,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 +297,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 +349,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 TransitionOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };

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;
@@ -24,18 +24,36 @@ declare class QueryBuilder<T = any> {
     then<TResult1 = PaginatedResult<T>, TResult2 = never>(onfulfilled?: ((value: PaginatedResult<T>) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
 }
 
-interface SetupPromptConfig {
-    siteName?: string;
-    siteId?: string;
-    apiKey?: string;
-    baseUrl?: string;
-    isSelfHosted?: boolean;
-    existingSite?: boolean;
-    defaultTechStack?: 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;
 }
-declare function generateFreshSetupPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): string;
-declare function generateAIPrompt(activeTab: "next" | "nuxt" | "react" | "vue", config: SetupPromptConfig): 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 +246,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 +297,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 +349,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 TransitionOptions, type WorkflowDocument, type WorkflowHistoryEntry, createClient };