@framework-m/desk 0.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/LICENSE +202 -0
  2. package/README.md +153 -0
  3. package/dist/auth.d.ts +11 -0
  4. package/dist/auth.d.ts.map +1 -0
  5. package/dist/authConfig.d.ts +42 -0
  6. package/dist/authConfig.d.ts.map +1 -0
  7. package/dist/components/CommandPalette.d.ts +49 -0
  8. package/dist/components/CommandPalette.d.ts.map +1 -0
  9. package/dist/components/breadcrumb/index.d.ts +2 -0
  10. package/dist/components/breadcrumb/index.d.ts.map +1 -0
  11. package/dist/components/feedback/AlertBanner.d.ts +8 -0
  12. package/dist/components/feedback/AlertBanner.d.ts.map +1 -0
  13. package/dist/components/feedback/ConfirmDialog.d.ts +13 -0
  14. package/dist/components/feedback/ConfirmDialog.d.ts.map +1 -0
  15. package/dist/components/feedback/index.d.ts +5 -0
  16. package/dist/components/feedback/index.d.ts.map +1 -0
  17. package/dist/components/form/AutoForm.d.ts +61 -0
  18. package/dist/components/form/AutoForm.d.ts.map +1 -0
  19. package/dist/components/form/LinkWidget.d.ts +20 -0
  20. package/dist/components/form/LinkWidget.d.ts.map +1 -0
  21. package/dist/components/form/index.d.ts +10 -0
  22. package/dist/components/form/index.d.ts.map +1 -0
  23. package/dist/components/form/templates.d.ts +58 -0
  24. package/dist/components/form/templates.d.ts.map +1 -0
  25. package/dist/components/layout/index.d.ts +3 -0
  26. package/dist/components/layout/index.d.ts.map +1 -0
  27. package/dist/components/menu/index.d.ts +2 -0
  28. package/dist/components/menu/index.d.ts.map +1 -0
  29. package/dist/components/table/AutoTable.d.ts +47 -0
  30. package/dist/components/table/AutoTable.d.ts.map +1 -0
  31. package/dist/components/table/BulkActionsBar.d.ts +40 -0
  32. package/dist/components/table/BulkActionsBar.d.ts.map +1 -0
  33. package/dist/components/table/EditableCell.d.ts +54 -0
  34. package/dist/components/table/EditableCell.d.ts.map +1 -0
  35. package/dist/components/table/index.d.ts +12 -0
  36. package/dist/components/table/index.d.ts.map +1 -0
  37. package/dist/components/workflow/StateBadge.d.ts +29 -0
  38. package/dist/components/workflow/StateBadge.d.ts.map +1 -0
  39. package/dist/components/workflow/WorkflowActions.d.ts +37 -0
  40. package/dist/components/workflow/WorkflowActions.d.ts.map +1 -0
  41. package/dist/components/workflow/index.d.ts +10 -0
  42. package/dist/components/workflow/index.d.ts.map +1 -0
  43. package/dist/config/i18n.d.ts +3 -0
  44. package/dist/config/i18n.d.ts.map +1 -0
  45. package/dist/config/index.d.ts +13 -0
  46. package/dist/config/index.d.ts.map +1 -0
  47. package/dist/config/registry.d.ts +75 -0
  48. package/dist/config/registry.d.ts.map +1 -0
  49. package/dist/config/types.d.ts +130 -0
  50. package/dist/config/types.d.ts.map +1 -0
  51. package/dist/config/useConfig.d.ts +18 -0
  52. package/dist/config/useConfig.d.ts.map +1 -0
  53. package/dist/constants.d.ts +35 -0
  54. package/dist/constants.d.ts.map +1 -0
  55. package/dist/data.d.ts +6 -0
  56. package/dist/data.d.ts.map +1 -0
  57. package/dist/hooks/index.d.ts +21 -0
  58. package/dist/hooks/index.d.ts.map +1 -0
  59. package/dist/hooks/types.d.ts +113 -0
  60. package/dist/hooks/types.d.ts.map +1 -0
  61. package/dist/hooks/useBulkActions.d.ts +82 -0
  62. package/dist/hooks/useBulkActions.d.ts.map +1 -0
  63. package/dist/hooks/useCommandPalette.d.ts +33 -0
  64. package/dist/hooks/useCommandPalette.d.ts.map +1 -0
  65. package/dist/hooks/useDocTypeMeta.d.ts +48 -0
  66. package/dist/hooks/useDocTypeMeta.d.ts.map +1 -0
  67. package/dist/hooks/useDocTypes.d.ts +66 -0
  68. package/dist/hooks/useDocTypes.d.ts.map +1 -0
  69. package/dist/hooks/useInlineEdit.d.ts +64 -0
  70. package/dist/hooks/useInlineEdit.d.ts.map +1 -0
  71. package/dist/hooks/useTranslation.d.ts +36 -0
  72. package/dist/hooks/useTranslation.d.ts.map +1 -0
  73. package/dist/hooks/useUIMeta.d.ts +111 -0
  74. package/dist/hooks/useUIMeta.d.ts.map +1 -0
  75. package/dist/hooks/useWorkflowActions.d.ts +75 -0
  76. package/dist/hooks/useWorkflowActions.d.ts.map +1 -0
  77. package/dist/index.d.ts +68 -0
  78. package/dist/index.d.ts.map +1 -0
  79. package/dist/index.js +5302 -0
  80. package/dist/index.js.map +1 -0
  81. package/dist/live.d.ts +21 -0
  82. package/dist/live.d.ts.map +1 -0
  83. package/dist/pages/FormView.d.ts +40 -0
  84. package/dist/pages/FormView.d.ts.map +1 -0
  85. package/dist/pages/ListView.d.ts +39 -0
  86. package/dist/pages/ListView.d.ts.map +1 -0
  87. package/dist/pages/LoginPage.d.ts +32 -0
  88. package/dist/pages/LoginPage.d.ts.map +1 -0
  89. package/dist/plugins/Slot.d.ts +27 -0
  90. package/dist/plugins/Slot.d.ts.map +1 -0
  91. package/dist/plugins/index.d.ts +14 -0
  92. package/dist/plugins/index.d.ts.map +1 -0
  93. package/dist/plugins/registry.d.ts +104 -0
  94. package/dist/plugins/registry.d.ts.map +1 -0
  95. package/dist/plugins/types.d.ts +130 -0
  96. package/dist/plugins/types.d.ts.map +1 -0
  97. package/dist/types.d.ts +51 -0
  98. package/dist/types.d.ts.map +1 -0
  99. package/dist/views/CalendarView.d.ts +14 -0
  100. package/dist/views/CalendarView.d.ts.map +1 -0
  101. package/dist/views/GanttView.d.ts +14 -0
  102. package/dist/views/GanttView.d.ts.map +1 -0
  103. package/dist/views/KanbanView.d.ts +16 -0
  104. package/dist/views/KanbanView.d.ts.map +1 -0
  105. package/dist/views/TreeView.d.ts +15 -0
  106. package/dist/views/TreeView.d.ts.map +1 -0
  107. package/dist/views/index.d.ts +17 -0
  108. package/dist/views/index.d.ts.map +1 -0
  109. package/dist/views/registry.d.ts +32 -0
  110. package/dist/views/registry.d.ts.map +1 -0
  111. package/dist/views/types.d.ts +97 -0
  112. package/dist/views/types.d.ts.map +1 -0
  113. package/dist/workspace/WorkspaceSection.d.ts +16 -0
  114. package/dist/workspace/WorkspaceSection.d.ts.map +1 -0
  115. package/dist/workspace/index.d.ts +12 -0
  116. package/dist/workspace/index.d.ts.map +1 -0
  117. package/dist/workspace/types.d.ts +95 -0
  118. package/dist/workspace/types.d.ts.map +1 -0
  119. package/dist/workspace/useWorkspaces.d.ts +38 -0
  120. package/dist/workspace/useWorkspaces.d.ts.map +1 -0
  121. package/package.json +89 -0
@@ -0,0 +1,75 @@
1
+ /**
2
+ * useWorkflowActions Hook
3
+ *
4
+ * Fetches available workflow transitions for a document and
5
+ * provides methods to execute transitions.
6
+ */
7
+ /**
8
+ * Workflow action (transition) definition
9
+ */
10
+ export interface WorkflowAction {
11
+ name: string;
12
+ label: string;
13
+ from_state: string;
14
+ to_state: string;
15
+ allowed: boolean;
16
+ reason?: string;
17
+ }
18
+ /**
19
+ * Workflow state information
20
+ */
21
+ export interface WorkflowState {
22
+ current_state: string;
23
+ docstatus: number;
24
+ workflow_name?: string;
25
+ }
26
+ /**
27
+ * Return type for useWorkflowActions hook
28
+ */
29
+ export interface UseWorkflowActionsResult {
30
+ /** Current workflow state */
31
+ state: WorkflowState | undefined;
32
+ /** Available actions for current user */
33
+ actions: WorkflowAction[];
34
+ /** Loading state */
35
+ isLoading: boolean;
36
+ /** Error if fetch failed */
37
+ error: Error | null;
38
+ /** Execute a workflow transition */
39
+ executeAction: (actionName: string) => Promise<void>;
40
+ /** Is an action currently executing */
41
+ isExecuting: boolean;
42
+ /** Refresh actions */
43
+ refetch: () => void;
44
+ }
45
+ /**
46
+ * Hook to manage workflow actions for a document
47
+ *
48
+ * @param doctype - The DocType name
49
+ * @param id - The document ID
50
+ * @param options - Additional options
51
+ *
52
+ * @example
53
+ * ```tsx
54
+ * const { state, actions, executeAction, isExecuting } = useWorkflowActions("Todo", todoId);
55
+ *
56
+ * return (
57
+ * <div>
58
+ * <StateBadge state={state?.current_state} />
59
+ * {actions.map(action => (
60
+ * <button
61
+ * key={action.name}
62
+ * onClick={() => executeAction(action.name)}
63
+ * disabled={!action.allowed || isExecuting}
64
+ * >
65
+ * {action.label}
66
+ * </button>
67
+ * ))}
68
+ * </div>
69
+ * );
70
+ * ```
71
+ */
72
+ export declare function useWorkflowActions(doctype: string, id: string | undefined, options?: {
73
+ enabled?: boolean;
74
+ }): UseWorkflowActionsResult;
75
+ //# sourceMappingURL=useWorkflowActions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useWorkflowActions.d.ts","sourceRoot":"","sources":["../../src/hooks/useWorkflowActions.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAUD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,6BAA6B;IAC7B,KAAK,EAAE,aAAa,GAAG,SAAS,CAAC;IACjC,yCAAyC;IACzC,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,oBAAoB;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,4BAA4B;IAC5B,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,oCAAoC;IACpC,aAAa,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD,uCAAuC;IACvC,WAAW,EAAE,OAAO,CAAC;IACrB,sBAAsB;IACtB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AA+CD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,MAAM,EACf,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAC9B,wBAAwB,CAkD1B"}
@@ -0,0 +1,68 @@
1
+ /**
2
+ * @framework-m/desk
3
+ *
4
+ * Business components, hooks, views, and providers for Framework M applications.
5
+ *
6
+ * This package provides everything a plugin or shell app needs to build
7
+ * DocType-aware UIs: forms, tables, views, workflow actions, config system,
8
+ * and Refine data/auth/live providers.
9
+ *
10
+ * @example
11
+ * ```tsx
12
+ * import { AutoForm, AutoTable, useDocTypeMeta, frameworkMDataProvider } from "@framework-m/desk";
13
+ * ```
14
+ */
15
+ export { frameworkMDataProvider } from './data';
16
+ export { authProvider } from './auth';
17
+ export { liveProvider, closeAllConnections } from './live';
18
+ export { API_URL, META_URL, WS_URL } from './constants';
19
+ export type { ListResponse, BaseDocument, UserIdentity, ApiError, FilterOperator, SortOrder, } from './types';
20
+ export { AutoForm } from './components/form';
21
+ export { LinkWidget, customTemplates, customWidgets } from './components/form';
22
+ export type { AutoFormProps } from './components/form';
23
+ export { AutoTable } from './components/table';
24
+ export { BulkActionsBar } from './components/table';
25
+ export { EditableCell } from './components/table';
26
+ export { WorkflowActions } from './components/workflow';
27
+ export { StateBadge } from './components/workflow';
28
+ export { CommandPalette } from './components/CommandPalette';
29
+ export { ConfirmDialog, AlertBanner } from './components/feedback';
30
+ export type { ConfirmDialogProps, AlertBannerProps, } from './components/feedback';
31
+ export { Menu } from './components/menu';
32
+ export { Breadcrumb } from './components/breadcrumb';
33
+ export { Layout } from './components/layout';
34
+ export { useDocTypeMeta, usePrefetchDocTypeMeta } from './hooks';
35
+ export type { UseDocTypeMetaResult } from './hooks';
36
+ export { useWorkflowActions } from './hooks';
37
+ export type { UseWorkflowActionsResult, WorkflowAction, WorkflowState, } from './hooks';
38
+ export { useInlineEdit } from './hooks';
39
+ export type { UseInlineEditOptions, UseInlineEditReturn, EditingCell, } from './hooks';
40
+ export { useBulkActions } from './hooks';
41
+ export type { UseBulkActionsOptions, UseBulkActionsReturn, BulkItem, } from './hooks';
42
+ export { useCommandPalette } from './hooks';
43
+ export type { UseCommandPaletteReturn } from './hooks';
44
+ export { useDocTypes } from './hooks';
45
+ export { useTranslation } from './hooks';
46
+ export type { UseTranslationResult } from './hooks/useTranslation';
47
+ export type { DocTypeMeta, DocTypeSchema, DocTypePermissions, LayoutConfig, WorkflowConfig, FieldSchema, JSONSchemaProperty, LayoutSection, WorkflowTransition, } from './hooks';
48
+ export { KanbanView } from './views';
49
+ export type { KanbanViewProps } from './views';
50
+ export { CalendarView } from './views';
51
+ export type { CalendarViewProps } from './views';
52
+ export { GanttView } from './views';
53
+ export type { GanttViewProps } from './views';
54
+ export { TreeView } from './views';
55
+ export type { TreeViewProps } from './views';
56
+ export { registerView, getViewComponent, getRegisteredViews, getViewRegistration, setDocTypeViews, getDocTypeViews, isViewAvailable, } from './views';
57
+ export type { ViewType, ViewProps, ViewRegistration, KanbanConfig, KanbanColumn, CalendarConfig, GanttConfig, TreeConfig, } from './views';
58
+ export { registerConfig, registerClientScript, getConfig, getFormConfig, getListConfig, getFieldConfig, getClientScripts, loadConfigFromUrl, clearConfigs, } from './config';
59
+ export { useConfig, useFormConfig, useListConfig, useFieldConfig, } from './config';
60
+ export type { DocTypeConfig, FormConfig, ListConfig, FieldConfig, ColumnConfig, SectionConfig, ClientScript, ClientScriptContext, } from './config';
61
+ export { Slot } from './plugins';
62
+ export { WorkspaceSection } from './workspace';
63
+ export { default as ListView } from './pages/ListView';
64
+ export { default as FormView } from './pages/FormView';
65
+ export { default as LoginPage } from './pages/LoginPage';
66
+ export { getAuthConfig } from './authConfig';
67
+ export type { AuthConfig, AuthStrategy, OIDCConfig } from './authConfig';
68
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAMH,OAAO,EAAE,sBAAsB,EAAE,MAAM,QAAQ,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAExD,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,SAAS,GACV,MAAM,SAAS,CAAC;AAOjB,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC/E,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAGvD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGlD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAGnD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAG7D,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACnE,YAAY,EACV,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAM7C,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AACjE,YAAY,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAEpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAC7C,YAAY,EACV,wBAAwB,EACxB,cAAc,EACd,aAAa,GACd,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,YAAY,EACV,oBAAoB,EACpB,mBAAmB,EACnB,WAAW,GACZ,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,YAAY,EACV,qBAAqB,EACrB,oBAAoB,EACpB,QAAQ,GACT,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,YAAY,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAEvD,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,YAAY,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,YAAY,EACV,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,WAAW,EACX,kBAAkB,EAClB,aAAa,EACb,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAMjB,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,YAAY,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE7C,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,eAAe,EACf,eAAe,EACf,eAAe,GAChB,MAAM,SAAS,CAAC;AAEjB,YAAY,EACV,QAAQ,EACR,SAAS,EACT,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,WAAW,EACX,UAAU,GACX,MAAM,SAAS,CAAC;AAMjB,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,YAAY,GACb,MAAM,UAAU,CAAC;AAElB,OAAO,EACL,SAAS,EACT,aAAa,EACb,aAAa,EACb,cAAc,GACf,MAAM,UAAU,CAAC;AAElB,YAAY,EACV,aAAa,EACb,UAAU,EACV,UAAU,EACV,WAAW,EACX,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,mBAAmB,GACpB,MAAM,UAAU,CAAC;AAMlB,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAMjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAM/C,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAMzD,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC"}