@terreno/admin-frontend 0.3.2 → 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 (67) hide show
  1. package/README.md +5 -0
  2. package/dist/AdminFieldRenderer.d.ts +36 -0
  3. package/dist/AdminFieldRenderer.js +41 -1
  4. package/dist/AdminFieldRenderer.js.map +1 -1
  5. package/dist/AdminModelForm.d.ts +51 -0
  6. package/dist/AdminModelForm.js +55 -4
  7. package/dist/AdminModelForm.js.map +1 -1
  8. package/dist/AdminModelList.d.ts +26 -0
  9. package/dist/AdminModelList.js +35 -5
  10. package/dist/AdminModelList.js.map +1 -1
  11. package/dist/AdminModelTable.d.ts +29 -0
  12. package/dist/AdminModelTable.js +45 -16
  13. package/dist/AdminModelTable.js.map +1 -1
  14. package/dist/AdminRefField.d.ts +35 -0
  15. package/dist/AdminRefField.js +36 -1
  16. package/dist/AdminRefField.js.map +1 -1
  17. package/dist/AdminScriptList.d.ts +10 -0
  18. package/dist/AdminScriptList.js +31 -0
  19. package/dist/AdminScriptList.js.map +1 -0
  20. package/dist/AdminScriptRunModal.d.ts +11 -0
  21. package/dist/AdminScriptRunModal.js +87 -0
  22. package/dist/AdminScriptRunModal.js.map +1 -0
  23. package/dist/ConfigurationScreen.d.ts +30 -0
  24. package/dist/ConfigurationScreen.js +128 -0
  25. package/dist/ConfigurationScreen.js.map +1 -0
  26. package/dist/DocumentStorageBrowser.d.ts +3 -0
  27. package/dist/DocumentStorageBrowser.js +317 -0
  28. package/dist/DocumentStorageBrowser.js.map +1 -0
  29. package/dist/index.d.ts +8 -1
  30. package/dist/index.js +7 -0
  31. package/dist/index.js.map +1 -1
  32. package/dist/types.d.ts +52 -0
  33. package/dist/types.js.map +1 -1
  34. package/dist/useAdminApi.d.ts +43 -0
  35. package/dist/useAdminApi.js +44 -1
  36. package/dist/useAdminApi.js.map +1 -1
  37. package/dist/useAdminConfig.d.ts +29 -0
  38. package/dist/useAdminConfig.js +30 -1
  39. package/dist/useAdminConfig.js.map +1 -1
  40. package/dist/useAdminScripts.d.ts +32 -0
  41. package/dist/useAdminScripts.js +36 -0
  42. package/dist/useAdminScripts.js.map +1 -0
  43. package/dist/useConfigurationApi.d.ts +34 -0
  44. package/dist/useConfigurationApi.js +53 -0
  45. package/dist/useConfigurationApi.js.map +1 -0
  46. package/dist/useDocumentStorageApi.d.ts +9 -0
  47. package/dist/useDocumentStorageApi.js +89 -0
  48. package/dist/useDocumentStorageApi.js.map +1 -0
  49. package/package.json +17 -3
  50. package/src/AdminFieldRenderer.tsx +57 -1
  51. package/src/AdminModelForm.tsx +69 -16
  52. package/src/AdminModelList.tsx +107 -21
  53. package/src/AdminModelTable.tsx +98 -68
  54. package/src/AdminRefField.tsx +36 -1
  55. package/src/AdminScriptList.test.tsx +124 -0
  56. package/src/AdminScriptList.tsx +96 -0
  57. package/src/AdminScriptRunModal.test.tsx +69 -0
  58. package/src/AdminScriptRunModal.tsx +188 -0
  59. package/src/ConfigurationScreen.tsx +319 -0
  60. package/src/DocumentStorageBrowser.tsx +641 -0
  61. package/src/index.tsx +12 -0
  62. package/src/types.ts +59 -0
  63. package/src/useAdminApi.ts +44 -1
  64. package/src/useAdminConfig.ts +30 -1
  65. package/src/useAdminScripts.ts +48 -0
  66. package/src/useConfigurationApi.ts +70 -0
  67. package/src/useDocumentStorageApi.ts +96 -0
@@ -1,5 +1,34 @@
1
1
  import { useMemo } from "react";
2
2
  const ENDPOINT_NAME = "adminConfig";
3
+ /**
4
+ * Hook that fetches admin panel configuration from the backend.
5
+ *
6
+ * Dynamically injects a query endpoint into the provided RTK Query API to fetch
7
+ * model metadata from `{baseUrl}/config`. Returns model configurations including
8
+ * field types, required fields, references, and display settings.
9
+ *
10
+ * @param api - RTK Query API instance to inject the endpoint into
11
+ * @param baseUrl - Base URL for admin routes (e.g., "/admin")
12
+ * @returns Object with `config` (model metadata), `isLoading`, and `error`
13
+ *
14
+ * @example
15
+ * ```typescript
16
+ * import {useAdminConfig} from "@terreno/admin-frontend";
17
+ * import {api} from "@/store/openApiSdk";
18
+ *
19
+ * function AdminScreen() {
20
+ * const {config, isLoading, error} = useAdminConfig(api, "/admin");
21
+ *
22
+ * if (isLoading) return <Spinner />;
23
+ * if (error || !config) return <Text>Error loading config</Text>;
24
+ *
25
+ * return <div>{config.models.map(m => <Card key={m.name}>{m.displayName}</Card>)}</div>;
26
+ * }
27
+ * ```
28
+ *
29
+ * @see AdminConfigResponse for the returned configuration structure
30
+ * @see AdminModelList for usage in the model list screen
31
+ */
3
32
  export const useAdminConfig = (api, baseUrl) => {
4
33
  const enhancedApi = useMemo(() => {
5
34
  return api.injectEndpoints({
@@ -11,7 +40,7 @@ export const useAdminConfig = (api, baseUrl) => {
11
40
  }),
12
41
  }),
13
42
  }),
14
- overrideExisting: false,
43
+ overrideExisting: true,
15
44
  });
16
45
  }, [api, baseUrl]);
17
46
  const useConfigQuery = enhancedApi.useAdminConfigQuery;
@@ -1 +1 @@
1
- {"version":3,"file":"useAdminConfig.js","sourceRoot":"","sources":["../src/useAdminConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAG9B,MAAM,aAAa,GAAG,aAAa,CAAC;AAEpC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAA4B,EAAE,OAAe,EAAE,EAAE;IAC9E,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE;QAC/B,OAAO,GAAG,CAAC,eAAe,CAAC;YACzB,SAAS,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,CAAC;gBAC1B,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;oBAC3B,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;wBACZ,MAAM,EAAE,KAAK;wBACb,GAAG,EAAE,GAAG,OAAO,SAAS;qBACzB,CAAC;iBACH,CAAC;aACH,CAAC;YACF,gBAAgB,EAAE,KAAK;SACxB,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IAEnB,MAAM,cAAc,GAAI,WAAmB,CAAC,mBAAmB,CAAC;IAEhE,MAAM,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAC,GAAG,cAAc,EAAE,CAAC;IAElD,OAAO,EAAC,MAAM,EAAE,IAAkC,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC;AACxE,CAAC,CAAC"}
1
+ {"version":3,"file":"useAdminConfig.js","sourceRoot":"","sources":["../src/useAdminConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAG9B,MAAM,aAAa,GAAG,aAAa,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAA4B,EAAE,OAAe,EAAE,EAAE;IAC9E,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE;QAC/B,OAAO,GAAG,CAAC,eAAe,CAAC;YACzB,SAAS,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,CAAC;gBAC1B,CAAC,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC;oBAC3B,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;wBACZ,MAAM,EAAE,KAAK;wBACb,GAAG,EAAE,GAAG,OAAO,SAAS;qBACzB,CAAC;iBACH,CAAC;aACH,CAAC;YACF,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IAEnB,MAAM,cAAc,GAAI,WAAmB,CAAC,mBAAmB,CAAC;IAEhE,MAAM,EAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAC,GAAG,cAAc,EAAE,CAAC;IAElD,OAAO,EAAC,MAAM,EAAE,IAAkC,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC;AACxE,CAAC,CAAC"}
@@ -0,0 +1,32 @@
1
+ import type { Api } from "@reduxjs/toolkit/query/react";
2
+ import type { BackgroundTask } from "./types";
3
+ export declare const useAdminScripts: (api: Api<any, any, any, any>, baseUrl: string) => {
4
+ useCancelScriptTaskMutation: () => [(taskId: string) => {
5
+ unwrap: () => Promise<{
6
+ task: BackgroundTask;
7
+ message: string;
8
+ }>;
9
+ }, {
10
+ isLoading: boolean;
11
+ }];
12
+ useGetScriptTaskQuery: (taskId: string, options?: {
13
+ skip?: boolean;
14
+ pollingInterval?: number;
15
+ }) => {
16
+ data: {
17
+ task: BackgroundTask;
18
+ } | undefined;
19
+ isLoading: boolean;
20
+ error: unknown;
21
+ };
22
+ useRunScriptMutation: () => [(args: {
23
+ name: string;
24
+ wetRun: boolean;
25
+ }) => {
26
+ unwrap: () => Promise<{
27
+ taskId: string;
28
+ }>;
29
+ }, {
30
+ isLoading: boolean;
31
+ }];
32
+ };
@@ -0,0 +1,36 @@
1
+ import { useMemo } from "react";
2
+ export const useAdminScripts = (api, baseUrl) => {
3
+ const enhancedApi = useMemo(() => {
4
+ return api.injectEndpoints({
5
+ endpoints: (build) => ({
6
+ adminCancelScriptTask: build.mutation({
7
+ invalidatesTags: ["admin_scriptTask"],
8
+ query: (taskId) => ({
9
+ method: "DELETE",
10
+ url: `${baseUrl}/scripts/tasks/${taskId}`,
11
+ }),
12
+ }),
13
+ adminGetScriptTask: build.query({
14
+ providesTags: ["admin_scriptTask"],
15
+ query: (taskId) => ({
16
+ method: "GET",
17
+ url: `${baseUrl}/scripts/tasks/${taskId}`,
18
+ }),
19
+ }),
20
+ adminRunScript: build.mutation({
21
+ query: ({ name, wetRun }) => ({
22
+ method: "POST",
23
+ url: `${baseUrl}/scripts/${name}/run?wetRun=${wetRun}`,
24
+ }),
25
+ }),
26
+ }),
27
+ overrideExisting: true,
28
+ });
29
+ }, [api, baseUrl]);
30
+ return {
31
+ useCancelScriptTaskMutation: enhancedApi.useAdminCancelScriptTaskMutation,
32
+ useGetScriptTaskQuery: enhancedApi.useAdminGetScriptTaskQuery,
33
+ useRunScriptMutation: enhancedApi.useAdminRunScriptMutation,
34
+ };
35
+ };
36
+ //# sourceMappingURL=useAdminScripts.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useAdminScripts.js","sourceRoot":"","sources":["../src/useAdminScripts.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAG9B,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAA4B,EAAE,OAAe,EAAE,EAAE;IAC/E,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE;QAC/B,OAAO,GAAG,CAAC,eAAe,CAAC;YACzB,SAAS,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,CAAC;gBAC1B,qBAAqB,EAAE,KAAK,CAAC,QAAQ,CAAC;oBACpC,eAAe,EAAE,CAAC,kBAAkB,CAAC;oBACrC,KAAK,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;wBAC1B,MAAM,EAAE,QAAQ;wBAChB,GAAG,EAAE,GAAG,OAAO,kBAAkB,MAAM,EAAE;qBAC1C,CAAC;iBACH,CAAC;gBACF,kBAAkB,EAAE,KAAK,CAAC,KAAK,CAAC;oBAC9B,YAAY,EAAE,CAAC,kBAAkB,CAAC;oBAClC,KAAK,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC;wBAC1B,MAAM,EAAE,KAAK;wBACb,GAAG,EAAE,GAAG,OAAO,kBAAkB,MAAM,EAAE;qBAC1C,CAAC;iBACH,CAAC;gBACF,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC;oBAC7B,KAAK,EAAE,CAAC,EAAC,IAAI,EAAE,MAAM,EAAkC,EAAE,EAAE,CAAC,CAAC;wBAC3D,MAAM,EAAE,MAAM;wBACd,GAAG,EAAE,GAAG,OAAO,YAAY,IAAI,eAAe,MAAM,EAAE;qBACvD,CAAC;iBACH,CAAC;aACH,CAAC;YACF,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IAEnB,OAAO;QACL,2BAA2B,EAAG,WAAmB,CAAC,gCAGjD;QACD,qBAAqB,EAAG,WAAmB,CAAC,0BAGuC;QACnF,oBAAoB,EAAG,WAAmB,CAAC,yBAG1C;KACF,CAAC;AACJ,CAAC,CAAC"}
@@ -0,0 +1,34 @@
1
+ import type { Api } from "@reduxjs/toolkit/query/react";
2
+ interface UseConfigurationApiOptions {
3
+ api: Api<any, any, any, any>;
4
+ basePath: string;
5
+ }
6
+ interface UseConfigurationApiResult {
7
+ useMetaQuery: () => {
8
+ data: any;
9
+ isLoading: boolean;
10
+ error: any;
11
+ };
12
+ useRefreshSecretsMutation: () => [any, {
13
+ isLoading: boolean;
14
+ }];
15
+ useUpdateMutation: () => [any, {
16
+ isLoading: boolean;
17
+ }];
18
+ useValuesQuery: () => {
19
+ data: any;
20
+ isLoading: boolean;
21
+ error: any;
22
+ };
23
+ }
24
+ /**
25
+ * Hook that generates RTK Query hooks for configuration management.
26
+ *
27
+ * Dynamically injects endpoints for:
28
+ * - `meta` — GET `{basePath}/meta` (schema metadata)
29
+ * - `values` — GET `{basePath}` (current configuration values)
30
+ * - `update` — PATCH `{basePath}` (update configuration)
31
+ * - `refreshSecrets` — POST `{basePath}/refresh-secrets` (trigger secret refresh)
32
+ */
33
+ export declare const useConfigurationApi: ({ api, basePath, }: UseConfigurationApiOptions) => UseConfigurationApiResult;
34
+ export {};
@@ -0,0 +1,53 @@
1
+ import { useMemo } from "react";
2
+ /**
3
+ * Hook that generates RTK Query hooks for configuration management.
4
+ *
5
+ * Dynamically injects endpoints for:
6
+ * - `meta` — GET `{basePath}/meta` (schema metadata)
7
+ * - `values` — GET `{basePath}` (current configuration values)
8
+ * - `update` — PATCH `{basePath}` (update configuration)
9
+ * - `refreshSecrets` — POST `{basePath}/refresh-secrets` (trigger secret refresh)
10
+ */
11
+ export const useConfigurationApi = ({ api, basePath, }) => {
12
+ const enhancedApi = useMemo(() => {
13
+ return api.enhanceEndpoints({ addTagTypes: ["configuration"] }).injectEndpoints({
14
+ endpoints: (build) => ({
15
+ configMeta: build.query({
16
+ query: () => ({
17
+ method: "GET",
18
+ url: `${basePath}/meta`,
19
+ }),
20
+ }),
21
+ configRefreshSecrets: build.mutation({
22
+ query: () => ({
23
+ method: "POST",
24
+ url: `${basePath}/refresh-secrets`,
25
+ }),
26
+ }),
27
+ configUpdate: build.mutation({
28
+ invalidatesTags: ["configuration"],
29
+ query: (body) => ({
30
+ body,
31
+ method: "PATCH",
32
+ url: basePath,
33
+ }),
34
+ }),
35
+ configValues: build.query({
36
+ providesTags: ["configuration"],
37
+ query: () => ({
38
+ method: "GET",
39
+ url: basePath,
40
+ }),
41
+ }),
42
+ }),
43
+ overrideExisting: true,
44
+ });
45
+ }, [api, basePath]);
46
+ return {
47
+ useMetaQuery: enhancedApi.useConfigMetaQuery,
48
+ useRefreshSecretsMutation: enhancedApi.useConfigRefreshSecretsMutation,
49
+ useUpdateMutation: enhancedApi.useConfigUpdateMutation,
50
+ useValuesQuery: enhancedApi.useConfigValuesQuery,
51
+ };
52
+ };
53
+ //# sourceMappingURL=useConfigurationApi.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useConfigurationApi.js","sourceRoot":"","sources":["../src/useConfigurationApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAc9B;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,EAClC,GAAG,EACH,QAAQ,GACmB,EAA6B,EAAE;IAC1D,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE;QAC/B,OAAO,GAAG,CAAC,gBAAgB,CAAC,EAAC,WAAW,EAAE,CAAC,eAAe,CAAC,EAAC,CAAC,CAAC,eAAe,CAAC;YAC5E,SAAS,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,CAAC;gBAC1B,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC;oBACtB,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;wBACZ,MAAM,EAAE,KAAK;wBACb,GAAG,EAAE,GAAG,QAAQ,OAAO;qBACxB,CAAC;iBACH,CAAC;gBACF,oBAAoB,EAAE,KAAK,CAAC,QAAQ,CAAC;oBACnC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;wBACZ,MAAM,EAAE,MAAM;wBACd,GAAG,EAAE,GAAG,QAAQ,kBAAkB;qBACnC,CAAC;iBACH,CAAC;gBACF,YAAY,EAAE,KAAK,CAAC,QAAQ,CAAC;oBAC3B,eAAe,EAAE,CAAC,eAAe,CAAC;oBAClC,KAAK,EAAE,CAAC,IAAS,EAAE,EAAE,CAAC,CAAC;wBACrB,IAAI;wBACJ,MAAM,EAAE,OAAO;wBACf,GAAG,EAAE,QAAQ;qBACd,CAAC;iBACH,CAAC;gBACF,YAAY,EAAE,KAAK,CAAC,KAAK,CAAC;oBACxB,YAAY,EAAE,CAAC,eAAe,CAAC;oBAC/B,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;wBACZ,MAAM,EAAE,KAAK;wBACb,GAAG,EAAE,QAAQ;qBACd,CAAC;iBACH,CAAC;aACH,CAAC;YACF,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEpB,OAAO;QACL,YAAY,EAAG,WAAmB,CAAC,kBAAkB;QACrD,yBAAyB,EAAG,WAAmB,CAAC,+BAA+B;QAC/E,iBAAiB,EAAG,WAAmB,CAAC,uBAAuB;QAC/D,cAAc,EAAG,WAAmB,CAAC,oBAAoB;KAC1D,CAAC;AACJ,CAAC,CAAC"}
@@ -0,0 +1,9 @@
1
+ import type { Api } from "@reduxjs/toolkit/query/react";
2
+ export declare const useDocumentStorageApi: (api: Api<any, any, any, any>, basePath: string) => {
3
+ useCreateFolderMutation: any;
4
+ useDeleteFolderMutation: any;
5
+ useDeleteMutation: any;
6
+ useLazyDownloadQuery: any;
7
+ useListQuery: any;
8
+ useUploadMutation: any;
9
+ };
@@ -0,0 +1,89 @@
1
+ import { useMemo } from "react";
2
+ export const useDocumentStorageApi = (api, basePath) => {
3
+ const enhancedApi = useMemo(() => {
4
+ return api.injectEndpoints({
5
+ endpoints: (build) => ({
6
+ documentStorageCreateFolder: build.mutation({
7
+ invalidatesTags: ["documentStorage"],
8
+ query: ({ folderName, prefix }) => ({
9
+ body: { folderName, prefix },
10
+ method: "POST",
11
+ url: `${basePath}/folder`,
12
+ }),
13
+ }),
14
+ documentStorageDelete: build.mutation({
15
+ invalidatesTags: ["documentStorage"],
16
+ query: (filePath) => ({
17
+ method: "DELETE",
18
+ url: `${basePath}/${encodeURIComponent(filePath)}`,
19
+ }),
20
+ }),
21
+ documentStorageDeleteFolder: build.mutation({
22
+ invalidatesTags: ["documentStorage"],
23
+ query: (folderPath) => ({
24
+ method: "DELETE",
25
+ url: `${basePath}/folder/${encodeURIComponent(folderPath)}`,
26
+ }),
27
+ }),
28
+ documentStorageDownload: build.query({
29
+ extraOptions: { maxRetries: 0 },
30
+ query: (filePath) => {
31
+ const url = `${basePath}/download/${encodeURIComponent(filePath)}`;
32
+ console.info("[documentStorage] download url:", url, "filePath:", filePath);
33
+ return {
34
+ method: "GET",
35
+ responseHandler: async (response) => {
36
+ console.info("[documentStorage] download response:", response.status, response.statusText, "content-type:", response.headers.get("content-type"));
37
+ if (response.ok) {
38
+ const blob = await response.blob();
39
+ console.info("[documentStorage] blob size:", blob.size, "type:", blob.type);
40
+ return blob;
41
+ }
42
+ const text = await response.text();
43
+ console.error("[documentStorage] error response body:", text);
44
+ try {
45
+ return JSON.parse(text);
46
+ }
47
+ catch (_a) {
48
+ return { detail: text, status: response.status };
49
+ }
50
+ },
51
+ url,
52
+ };
53
+ },
54
+ }),
55
+ documentStorageList: build.query({
56
+ providesTags: ["documentStorage"],
57
+ query: (prefix) => ({
58
+ method: "GET",
59
+ params: prefix ? { prefix } : {},
60
+ url: `${basePath}/`,
61
+ }),
62
+ }),
63
+ documentStorageUpload: build.mutation({
64
+ invalidatesTags: ["documentStorage"],
65
+ query: ({ formData, prefix }) => {
66
+ if (prefix) {
67
+ formData.append("prefix", prefix);
68
+ }
69
+ return {
70
+ body: formData,
71
+ method: "POST",
72
+ url: `${basePath}/`,
73
+ };
74
+ },
75
+ }),
76
+ }),
77
+ overrideExisting: false,
78
+ });
79
+ }, [api, basePath]);
80
+ return {
81
+ useCreateFolderMutation: enhancedApi.useDocumentStorageCreateFolderMutation,
82
+ useDeleteFolderMutation: enhancedApi.useDocumentStorageDeleteFolderMutation,
83
+ useDeleteMutation: enhancedApi.useDocumentStorageDeleteMutation,
84
+ useLazyDownloadQuery: enhancedApi.useLazyDocumentStorageDownloadQuery,
85
+ useListQuery: enhancedApi.useDocumentStorageListQuery,
86
+ useUploadMutation: enhancedApi.useDocumentStorageUploadMutation,
87
+ };
88
+ };
89
+ //# sourceMappingURL=useDocumentStorageApi.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useDocumentStorageApi.js","sourceRoot":"","sources":["../src/useDocumentStorageApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAE9B,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,GAA4B,EAAE,QAAgB,EAAE,EAAE;IACtF,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,EAAE;QAC/B,OAAO,GAAG,CAAC,eAAe,CAAC;YACzB,SAAS,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,CAAC;gBAC1B,2BAA2B,EAAE,KAAK,CAAC,QAAQ,CAAC;oBAC1C,eAAe,EAAE,CAAC,iBAAiB,CAAC;oBACpC,KAAK,EAAE,CAAC,EAAC,UAAU,EAAE,MAAM,EAAwC,EAAE,EAAE,CAAC,CAAC;wBACvE,IAAI,EAAE,EAAC,UAAU,EAAE,MAAM,EAAC;wBAC1B,MAAM,EAAE,MAAM;wBACd,GAAG,EAAE,GAAG,QAAQ,SAAS;qBAC1B,CAAC;iBACH,CAAC;gBACF,qBAAqB,EAAE,KAAK,CAAC,QAAQ,CAAC;oBACpC,eAAe,EAAE,CAAC,iBAAiB,CAAC;oBACpC,KAAK,EAAE,CAAC,QAAgB,EAAE,EAAE,CAAC,CAAC;wBAC5B,MAAM,EAAE,QAAQ;wBAChB,GAAG,EAAE,GAAG,QAAQ,IAAI,kBAAkB,CAAC,QAAQ,CAAC,EAAE;qBACnD,CAAC;iBACH,CAAC;gBACF,2BAA2B,EAAE,KAAK,CAAC,QAAQ,CAAC;oBAC1C,eAAe,EAAE,CAAC,iBAAiB,CAAC;oBACpC,KAAK,EAAE,CAAC,UAAkB,EAAE,EAAE,CAAC,CAAC;wBAC9B,MAAM,EAAE,QAAQ;wBAChB,GAAG,EAAE,GAAG,QAAQ,WAAW,kBAAkB,CAAC,UAAU,CAAC,EAAE;qBAC5D,CAAC;iBACH,CAAC;gBACF,uBAAuB,EAAE,KAAK,CAAC,KAAK,CAAC;oBACnC,YAAY,EAAE,EAAC,UAAU,EAAE,CAAC,EAAC;oBAC7B,KAAK,EAAE,CAAC,QAAgB,EAAE,EAAE;wBAC1B,MAAM,GAAG,GAAG,GAAG,QAAQ,aAAa,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACnE,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,GAAG,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;wBAC5E,OAAO;4BACL,MAAM,EAAE,KAAK;4BACb,eAAe,EAAE,KAAK,EAAE,QAAkB,EAAE,EAAE;gCAC5C,OAAO,CAAC,IAAI,CACV,sCAAsC,EACtC,QAAQ,CAAC,MAAM,EACf,QAAQ,CAAC,UAAU,EACnB,eAAe,EACf,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CACrC,CAAC;gCACF,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;oCAChB,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;oCACnC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;oCAC5E,OAAO,IAAI,CAAC;gCACd,CAAC;gCACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gCACnC,OAAO,CAAC,KAAK,CAAC,wCAAwC,EAAE,IAAI,CAAC,CAAC;gCAC9D,IAAI,CAAC;oCACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gCAC1B,CAAC;gCAAC,WAAM,CAAC;oCACP,OAAO,EAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAC,CAAC;gCACjD,CAAC;4BACH,CAAC;4BACD,GAAG;yBACJ,CAAC;oBACJ,CAAC;iBACF,CAAC;gBACF,mBAAmB,EAAE,KAAK,CAAC,KAAK,CAAC;oBAC/B,YAAY,EAAE,CAAC,iBAAiB,CAAC;oBACjC,KAAK,EAAE,CAAC,MAAe,EAAE,EAAE,CAAC,CAAC;wBAC3B,MAAM,EAAE,KAAK;wBACb,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAC,MAAM,EAAC,CAAC,CAAC,CAAC,EAAE;wBAC9B,GAAG,EAAE,GAAG,QAAQ,GAAG;qBACpB,CAAC;iBACH,CAAC;gBACF,qBAAqB,EAAE,KAAK,CAAC,QAAQ,CAAC;oBACpC,eAAe,EAAE,CAAC,iBAAiB,CAAC;oBACpC,KAAK,EAAE,CAAC,EAAC,QAAQ,EAAE,MAAM,EAAwC,EAAE,EAAE;wBACnE,IAAI,MAAM,EAAE,CAAC;4BACX,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;wBACpC,CAAC;wBACD,OAAO;4BACL,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE,MAAM;4BACd,GAAG,EAAE,GAAG,QAAQ,GAAG;yBACpB,CAAC;oBACJ,CAAC;iBACF,CAAC;aACH,CAAC;YACF,gBAAgB,EAAE,KAAK;SACxB,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEpB,OAAO;QACL,uBAAuB,EAAG,WAAmB,CAAC,sCAAsC;QACpF,uBAAuB,EAAG,WAAmB,CAAC,sCAAsC;QACpF,iBAAiB,EAAG,WAAmB,CAAC,gCAAgC;QACxE,oBAAoB,EAAG,WAAmB,CAAC,mCAAmC;QAC9E,YAAY,EAAG,WAAmB,CAAC,2BAA2B;QAC9D,iBAAiB,EAAG,WAAmB,CAAC,gCAAgC;KACzE,CAAC;AACJ,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "dependencies": {
3
- "@terreno/ui": "0.3.1",
3
+ "@terreno/ui": "0.4.2",
4
4
  "expo-router": "~6.0.19",
5
5
  "lodash": "^4.17.23",
6
6
  "luxon": "^3.7.2",
@@ -8,6 +8,7 @@
8
8
  },
9
9
  "description": "Admin panel frontend screens for @terreno/api backends",
10
10
  "devDependencies": {
11
+ "@biomejs/biome": "^2.3.6",
11
12
  "@reduxjs/toolkit": "^2.11.1",
12
13
  "@types/lodash": "^4.17.17",
13
14
  "@types/luxon": "^3.7.1",
@@ -26,11 +27,24 @@
26
27
  "peerDependencies": {
27
28
  "@reduxjs/toolkit": "^2.11.1",
28
29
  "react": "19.1.0",
30
+ "react-native-webview": "13.15.0",
29
31
  "react-redux": "^9.2.0"
30
32
  },
33
+ "peerDependenciesMeta": {
34
+ "react-native-webview": {
35
+ "optional": true
36
+ }
37
+ },
31
38
  "scripts": {
32
- "compile": "tsc"
39
+ "compile": "tsc",
40
+ "compile:watch": "tsc -w",
41
+ "dev": "tsc -w",
42
+ "lint": "biome check .",
43
+ "lint:fix": "biome check --write .",
44
+ "lint:unsafefix": "biome check --write --unsafe .",
45
+ "test": "bun test",
46
+ "test:ci": "bun test"
33
47
  },
34
48
  "types": "dist/index.d.ts",
35
- "version": "0.3.2"
49
+ "version": "0.4.2"
36
50
  }
@@ -1,4 +1,10 @@
1
- import {BooleanField, DateTimeField, SelectField, TextField} from "@terreno/ui";
1
+ import {
2
+ BooleanField,
3
+ DateTimeField,
4
+ MarkdownEditorField,
5
+ SelectField,
6
+ TextField,
7
+ } from "@terreno/ui";
2
8
  import startCase from "lodash/startCase";
3
9
  import React from "react";
4
10
  import {AdminRefField} from "./AdminRefField";
@@ -13,6 +19,42 @@ interface AdminFieldRendererProps extends AdminScreenProps {
13
19
  modelConfigs?: Array<{name: string; routePath: string}>;
14
20
  }
15
21
 
22
+ /**
23
+ * Renders an appropriate input field for a given model field in the admin form.
24
+ *
25
+ * Maps field types to the correct UI component:
26
+ * - `boolean` → BooleanField
27
+ * - `number` → TextField with number validation
28
+ * - `date`/`datetime` → DateTimeField
29
+ * - `enum` → SelectField with enum values as options
30
+ * - ObjectId with `ref` → AdminRefField (select from referenced model)
31
+ * - Default → TextField
32
+ *
33
+ * @param props - Component props
34
+ * @param props.fieldKey - The field key/name in the model
35
+ * @param props.fieldConfig - Field configuration metadata from backend
36
+ * @param props.value - Current field value
37
+ * @param props.onChange - Callback when field value changes
38
+ * @param props.errorText - Optional validation error message
39
+ * @param props.baseUrl - Base URL for admin routes
40
+ * @param props.api - RTK Query API instance
41
+ * @param props.modelConfigs - Available model configurations for reference field lookups
42
+ *
43
+ * @example
44
+ * ```typescript
45
+ * <AdminFieldRenderer
46
+ * fieldKey="status"
47
+ * fieldConfig={{type: "string", required: true, enum: ["active", "inactive"]}}
48
+ * value={formState.status}
49
+ * onChange={(val) => setFormState({...formState, status: val})}
50
+ * baseUrl="/admin"
51
+ * api={api}
52
+ * />
53
+ * ```
54
+ *
55
+ * @see AdminRefField for reference field rendering
56
+ * @see AdminModelForm for form usage
57
+ */
16
58
  export const AdminFieldRenderer: React.FC<AdminFieldRendererProps> = ({
17
59
  fieldKey,
18
60
  fieldConfig,
@@ -110,6 +152,20 @@ export const AdminFieldRenderer: React.FC<AdminFieldRendererProps> = ({
110
152
  );
111
153
  }
112
154
 
155
+ // Markdown widget
156
+ if (fieldConfig.widget === "markdown") {
157
+ return (
158
+ <MarkdownEditorField
159
+ errorText={errorText}
160
+ helperText={helperText}
161
+ onChange={onChange}
162
+ testID={`admin-field-${fieldKey}`}
163
+ title={label}
164
+ value={value ?? ""}
165
+ />
166
+ );
167
+ }
168
+
113
169
  // Default: string -> TextField
114
170
  return (
115
171
  <TextField
@@ -22,6 +22,71 @@ const getEditableFields = (
22
22
  return Object.entries(fields).filter(([key]) => !SYSTEM_FIELDS.has(key));
23
23
  };
24
24
 
25
+ const DeleteButton: React.FC<{loading: boolean; onDelete: () => void}> = ({loading, onDelete}) => (
26
+ <Button
27
+ confirmationText="Are you sure you want to delete this item?"
28
+ loading={loading}
29
+ onClick={onDelete}
30
+ testID="admin-delete-button"
31
+ text="Delete"
32
+ variant="destructive"
33
+ withConfirmation
34
+ />
35
+ );
36
+
37
+ const EmptyFields: React.FC = () => <Text color="secondaryDark">No editable fields.</Text>;
38
+
39
+ /**
40
+ * Form screen for creating or editing a model instance in the admin panel.
41
+ *
42
+ * Auto-generates form fields based on the model schema from the backend configuration.
43
+ * Handles field validation, type-specific inputs (text, boolean, select, date, reference fields),
44
+ * and save/cancel actions. System fields (_id, __v, created, updated, deleted) are automatically
45
+ * excluded from the form.
46
+ *
47
+ * @param props - Component props
48
+ * @param props.baseUrl - Base URL for admin routes (e.g., "/admin")
49
+ * @param props.api - RTK Query API instance for making authenticated requests
50
+ * @param props.modelName - Name of the model to create/edit (e.g., "User")
51
+ * @param props.mode - Form mode: "create" for new items, "edit" for existing items
52
+ * @param props.itemId - ID of the item to edit (required when mode is "edit")
53
+ *
54
+ * @example
55
+ * ```typescript
56
+ * import {AdminModelForm} from "@terreno/admin-frontend";
57
+ * import {api} from "@/store/openApiSdk";
58
+ * import {useLocalSearchParams} from "expo-router";
59
+ *
60
+ * function AdminCreateScreen() {
61
+ * const {modelName} = useLocalSearchParams();
62
+ * return (
63
+ * <AdminModelForm
64
+ * baseUrl="/admin"
65
+ * api={api}
66
+ * modelName={modelName as string}
67
+ * mode="create"
68
+ * />
69
+ * );
70
+ * }
71
+ *
72
+ * function AdminEditScreen() {
73
+ * const {modelName, id} = useLocalSearchParams();
74
+ * return (
75
+ * <AdminModelForm
76
+ * baseUrl="/admin"
77
+ * api={api}
78
+ * modelName={modelName as string}
79
+ * mode="edit"
80
+ * itemId={id as string}
81
+ * />
82
+ * );
83
+ * }
84
+ * ```
85
+ *
86
+ * @see AdminFieldRenderer for field type rendering
87
+ * @see AdminModelTable for the list view
88
+ * @see SYSTEM_FIELDS for excluded fields
89
+ */
25
90
  export const AdminModelForm: React.FC<AdminModelFormProps> = ({
26
91
  baseUrl,
27
92
  api,
@@ -42,7 +107,6 @@ export const AdminModelForm: React.FC<AdminModelFormProps> = ({
42
107
 
43
108
  const toast = useToast();
44
109
 
45
- // Set the navigation header title based on mode and model name
46
110
  useEffect(() => {
47
111
  if (!modelConfig) {
48
112
  return;
@@ -66,7 +130,6 @@ export const AdminModelForm: React.FC<AdminModelFormProps> = ({
66
130
  const [updateItem, {isLoading: isUpdating}] = useUpdateMutation();
67
131
  const [deleteItem, {isLoading: isDeleting}] = useDeleteMutation();
68
132
 
69
- // Initialize form state from fetched item in edit mode
70
133
  useEffect(() => {
71
134
  if (mode === "edit" && itemData && !isInitialized) {
72
135
  const initial: Record<string, any> = {};
@@ -80,7 +143,6 @@ export const AdminModelForm: React.FC<AdminModelFormProps> = ({
80
143
  }
81
144
  }, [mode, itemData, modelConfig, isInitialized]);
82
145
 
83
- // Initialize default values in create mode
84
146
  useEffect(() => {
85
147
  if (mode === "create" && modelConfig && !isInitialized) {
86
148
  const initial: Record<string, any> = {};
@@ -165,6 +227,7 @@ export const AdminModelForm: React.FC<AdminModelFormProps> = ({
165
227
 
166
228
  const editableFields = getEditableFields(modelConfig.fields);
167
229
  const isSaving = isCreating || isUpdating;
230
+ const saveLabel = mode === "create" ? "Create" : "Save";
168
231
 
169
232
  const modelConfigs =
170
233
  config?.models.map((m: AdminModelConfig) => ({name: m.name, routePath: m.routePath})) ?? [];
@@ -174,23 +237,13 @@ export const AdminModelForm: React.FC<AdminModelFormProps> = ({
174
237
  footer={
175
238
  <Box direction="row" gap={2} justifyContent="between" padding={2}>
176
239
  <Box>
177
- {mode === "edit" && (
178
- <Button
179
- confirmationText="Are you sure you want to delete this item?"
180
- loading={isDeleting}
181
- onClick={handleDelete}
182
- testID="admin-delete-button"
183
- text="Delete"
184
- variant="destructive"
185
- withConfirmation
186
- />
187
- )}
240
+ {mode === "edit" && <DeleteButton loading={isDeleting} onDelete={handleDelete} />}
188
241
  </Box>
189
242
  <Button
190
243
  loading={isSaving}
191
244
  onClick={handleSave}
192
245
  testID="admin-save-button"
193
- text={mode === "create" ? "Create" : "Save"}
246
+ text={saveLabel}
194
247
  variant="primary"
195
248
  />
196
249
  </Box>
@@ -212,7 +265,7 @@ export const AdminModelForm: React.FC<AdminModelFormProps> = ({
212
265
  value={formState[fieldKey]}
213
266
  />
214
267
  ))}
215
- {editableFields.length === 0 && <Text color="secondaryDark">No editable fields.</Text>}
268
+ {editableFields.length === 0 && <EmptyFields />}
216
269
  </Box>
217
270
  </Page>
218
271
  );