convex-cms 0.0.1

package/dist/client/workflows.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Custom Workflow States
+ *
+ * Allows defining custom workflow states and transitions beyond the
+ * default draft/published/archived/scheduled states.
+ *
+ * @example
+ * const editorialWorkflow = defineWorkflow({
+ *   states: [
+ *     { name: "draft", displayName: "Draft", color: "gray" },
+ *     { name: "in_review", displayName: "In Review", color: "yellow" },
+ *     { name: "approved", displayName: "Approved", color: "blue" },
+ *     { name: "published", displayName: "Published", color: "green", isPublished: true },
+ *     { name: "archived", displayName: "Archived", color: "red" },
+ *   ],
+ *   transitions: {
+ *     draft: ["in_review"],
+ *     in_review: ["approved", "draft"],
+ *     approved: ["published", "in_review"],
+ *     published: ["archived", "draft"],
+ *     archived: ["draft"],
+ *   },
+ * });
+ */
+export type WorkflowStateColor = "gray" | "yellow" | "blue" | "green" | "red" | "purple" | "orange";
+export interface WorkflowState {
+    name: string;
+    displayName: string;
+    color: WorkflowStateColor;
+    icon?: string;
+    isPublished?: boolean;
+    description?: string;
+}
+export interface WorkflowConfig {
+    states: WorkflowState[];
+    transitions: Record<string, string[]>;
+    initialState?: string;
+}
+export declare const DEFAULT_WORKFLOW: WorkflowConfig;
+export declare function defineWorkflow(config: WorkflowConfig): WorkflowConfig;
+export declare function getWorkflowState(workflow: WorkflowConfig, stateName: string): WorkflowState | undefined;
+export declare function getAvailableTransitions(workflow: WorkflowConfig, currentState: string): WorkflowState[];
+export declare function canTransition(workflow: WorkflowConfig, from: string, to: string): boolean;
+export declare function isPublishedState(workflow: WorkflowConfig, stateName: string): boolean;
+export declare function getInitialState(workflow: WorkflowConfig): string;
+export declare function getAllPublishedStates(workflow: WorkflowConfig): WorkflowState[];
+export declare function validateWorkflowTransition(workflow: WorkflowConfig, from: string, to: string): {
+    valid: boolean;
+    error?: string;
+};
+//# sourceMappingURL=workflows.d.ts.map

package/dist/client/workflows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../../src/client/workflows.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEpG,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,kBAAkB,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,aAAa,EAAE,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,gBAAgB,EAAE,cAoB9B,CAAC;AAEF,wBAAgB,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAsBrE;AAED,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,cAAc,EACxB,SAAS,EAAE,MAAM,GAChB,aAAa,GAAG,SAAS,CAE3B;AAED,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,cAAc,EACxB,YAAY,EAAE,MAAM,GACnB,aAAa,EAAE,CAKjB;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAEzF;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAGrF;AAED,wBAAgB,eAAe,CAAC,QAAQ,EAAE,cAAc,GAAG,MAAM,CAEhE;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,cAAc,GAAG,aAAa,EAAE,CAE/E;AAED,wBAAgB,0BAA0B,CACxC,QAAQ,EAAE,cAAc,EACxB,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,GACT;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAcpC"}

package/dist/client/workflows.js

@@ -0,0 +1,103 @@
+/**
+ * Custom Workflow States
+ *
+ * Allows defining custom workflow states and transitions beyond the
+ * default draft/published/archived/scheduled states.
+ *
+ * @example
+ * const editorialWorkflow = defineWorkflow({
+ *   states: [
+ *     { name: "draft", displayName: "Draft", color: "gray" },
+ *     { name: "in_review", displayName: "In Review", color: "yellow" },
+ *     { name: "approved", displayName: "Approved", color: "blue" },
+ *     { name: "published", displayName: "Published", color: "green", isPublished: true },
+ *     { name: "archived", displayName: "Archived", color: "red" },
+ *   ],
+ *   transitions: {
+ *     draft: ["in_review"],
+ *     in_review: ["approved", "draft"],
+ *     approved: ["published", "in_review"],
+ *     published: ["archived", "draft"],
+ *     archived: ["draft"],
+ *   },
+ * });
+ */
+export const DEFAULT_WORKFLOW = {
+    states: [
+        { name: "draft", displayName: "Draft", color: "gray", icon: "FileEdit" },
+        {
+            name: "published",
+            displayName: "Published",
+            color: "green",
+            icon: "Globe",
+            isPublished: true,
+        },
+        { name: "archived", displayName: "Archived", color: "red", icon: "Archive" },
+        { name: "scheduled", displayName: "Scheduled", color: "blue", icon: "Clock" },
+    ],
+    transitions: {
+        draft: ["published", "scheduled", "archived"],
+        published: ["draft", "archived"],
+        archived: ["draft"],
+        scheduled: ["draft", "published"],
+    },
+    initialState: "draft",
+};
+export function defineWorkflow(config) {
+    const stateNames = new Set(config.states.map((s) => s.name));
+    for (const [from, tos] of Object.entries(config.transitions)) {
+        if (!stateNames.has(from)) {
+            throw new Error(`Workflow transition source "${from}" is not a valid state`);
+        }
+        for (const to of tos) {
+            if (!stateNames.has(to)) {
+                throw new Error(`Workflow transition target "${to}" is not a valid state`);
+            }
+        }
+    }
+    if (config.initialState && !stateNames.has(config.initialState)) {
+        throw new Error(`Initial state "${config.initialState}" is not a valid state`);
+    }
+    return Object.freeze({
+        ...config,
+        initialState: config.initialState ?? config.states[0]?.name ?? "draft",
+    });
+}
+export function getWorkflowState(workflow, stateName) {
+    return workflow.states.find((s) => s.name === stateName);
+}
+export function getAvailableTransitions(workflow, currentState) {
+    const targets = workflow.transitions[currentState] ?? [];
+    return targets
+        .map((name) => getWorkflowState(workflow, name))
+        .filter((s) => s !== undefined);
+}
+export function canTransition(workflow, from, to) {
+    return (workflow.transitions[from] ?? []).includes(to);
+}
+export function isPublishedState(workflow, stateName) {
+    const state = getWorkflowState(workflow, stateName);
+    return state?.isPublished === true;
+}
+export function getInitialState(workflow) {
+    return workflow.initialState ?? workflow.states[0]?.name ?? "draft";
+}
+export function getAllPublishedStates(workflow) {
+    return workflow.states.filter((s) => s.isPublished);
+}
+export function validateWorkflowTransition(workflow, from, to) {
+    if (!getWorkflowState(workflow, from)) {
+        return { valid: false, error: `Invalid source state: ${from}` };
+    }
+    if (!getWorkflowState(workflow, to)) {
+        return { valid: false, error: `Invalid target state: ${to}` };
+    }
+    if (!canTransition(workflow, from, to)) {
+        return {
+            valid: false,
+            error: `Transition from "${from}" to "${to}" is not allowed`,
+        };
+    }
+    return { valid: true };
+}
+//# sourceMappingURL=workflows.js.map

package/dist/client/workflows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../../src/client/workflows.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAmBH,MAAM,CAAC,MAAM,gBAAgB,GAAmB;IAC9C,MAAM,EAAE;QACN,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE;QACxE;YACE,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,WAAW;YACxB,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,IAAI;SAClB;QACD,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE;QAC5E,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE;KAC9E;IACD,WAAW,EAAE;QACX,KAAK,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC;QAC7C,SAAS,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC;QAChC,QAAQ,EAAE,CAAC,OAAO,CAAC;QACnB,SAAS,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC;KAClC;IACD,YAAY,EAAE,OAAO;CACtB,CAAC;AAEF,MAAM,UAAU,cAAc,CAAC,MAAsB;IACnD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE7D,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;QAC7D,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,wBAAwB,CAAC,CAAC;QAC/E,CAAC;QACD,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,+BAA+B,EAAE,wBAAwB,CAAC,CAAC;YAC7E,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,YAAY,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;QAChE,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,CAAC,YAAY,wBAAwB,CAAC,CAAC;IACjF,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,GAAG,MAAM;QACT,YAAY,EAAE,MAAM,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,OAAO;KACvE,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,QAAwB,EACxB,SAAiB;IAEjB,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,QAAwB,EACxB,YAAoB;IAEpB,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;IACzD,OAAO,OAAO;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SAC/C,MAAM,CAAC,CAAC,CAAC,EAAsB,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAwB,EAAE,IAAY,EAAE,EAAU;IAC9E,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;AACzD,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,QAAwB,EAAE,SAAiB;IAC1E,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACpD,OAAO,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,QAAwB;IACtD,OAAO,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,OAAO,CAAC;AACtE,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,QAAwB;IAC5D,OAAO,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,QAAwB,EACxB,IAAY,EACZ,EAAU;IAEV,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;QACtC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,IAAI,EAAE,EAAE,CAAC;IAClE,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,CAAC;QACpC,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,yBAAyB,EAAE,EAAE,EAAE,CAAC;IAChE,CAAC;IACD,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC;QACvC,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,oBAAoB,IAAI,SAAS,EAAE,kBAAkB;SAC7D,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACzB,CAAC"}