@swarm.ing/pieui 2.0.10 → 2.0.13

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 (70) hide show
  1. package/README.md +48 -0
  2. package/dist/cli.js +437 -193
  3. package/dist/code/args.d.ts.map +1 -1
  4. package/dist/code/commands/add.d.ts +2 -2
  5. package/dist/code/commands/add.d.ts.map +1 -1
  6. package/dist/code/commands/create.d.ts +2 -0
  7. package/dist/code/commands/create.d.ts.map +1 -0
  8. package/dist/code/commands/init.d.ts.map +1 -1
  9. package/dist/code/commands/pageAdd.d.ts +2 -0
  10. package/dist/code/commands/pageAdd.d.ts.map +1 -0
  11. package/dist/code/public/favicon.ico +0 -0
  12. package/dist/code/public/favicon.svg +1 -0
  13. package/dist/code/public/pieui.png +0 -0
  14. package/dist/code/public/swarm.ing.png +0 -0
  15. package/dist/code/templates/componentTypes.d.ts +2 -1
  16. package/dist/code/templates/componentTypes.d.ts.map +1 -1
  17. package/dist/code/templates/env.d.ts +2 -0
  18. package/dist/code/templates/env.d.ts.map +1 -0
  19. package/dist/code/templates/homePage.d.ts +2 -0
  20. package/dist/code/templates/homePage.d.ts.map +1 -0
  21. package/dist/code/templates/index.d.ts +7 -4
  22. package/dist/code/templates/index.d.ts.map +1 -1
  23. package/dist/code/templates/loadingScreen.d.ts +2 -0
  24. package/dist/code/templates/loadingScreen.d.ts.map +1 -0
  25. package/dist/code/templates/nextConfig.d.ts +1 -1
  26. package/dist/code/templates/nextConfig.d.ts.map +1 -1
  27. package/dist/code/templates/pages/components/complexComponent.d.ts +3 -0
  28. package/dist/code/templates/pages/components/complexComponent.d.ts.map +1 -0
  29. package/dist/code/templates/pages/components/complexContainerComponent.d.ts +3 -0
  30. package/dist/code/templates/pages/components/complexContainerComponent.d.ts.map +1 -0
  31. package/dist/code/templates/pages/components/index.d.ts +5 -0
  32. package/dist/code/templates/pages/components/index.d.ts.map +1 -0
  33. package/dist/code/templates/pages/components/shared.d.ts +5 -0
  34. package/dist/code/templates/pages/components/shared.d.ts.map +1 -0
  35. package/dist/code/templates/pages/components/simpleComponent.d.ts +3 -0
  36. package/dist/code/templates/pages/components/simpleComponent.d.ts.map +1 -0
  37. package/dist/code/templates/pages/components/simpleContainerComponent.d.ts +3 -0
  38. package/dist/code/templates/pages/components/simpleContainerComponent.d.ts.map +1 -0
  39. package/dist/code/templates/pages/index.d.ts +6 -0
  40. package/dist/code/templates/pages/index.d.ts.map +1 -0
  41. package/dist/code/templates/pages/page.d.ts +2 -0
  42. package/dist/code/templates/pages/page.d.ts.map +1 -0
  43. package/dist/code/templates/rootLayout.d.ts +2 -0
  44. package/dist/code/templates/rootLayout.d.ts.map +1 -0
  45. package/dist/code/templates/sharedPage.d.ts +2 -0
  46. package/dist/code/templates/sharedPage.d.ts.map +1 -0
  47. package/dist/code/types.d.ts +11 -0
  48. package/dist/code/types.d.ts.map +1 -1
  49. package/package.json +5 -13
  50. package/dist/__tests__/step1-local.test.d.cts +0 -2
  51. package/dist/__tests__/step1-local.test.d.cts.map +0 -1
  52. package/dist/__tests__/step2-remote.test.d.cts +0 -2
  53. package/dist/__tests__/step2-remote.test.d.cts.map +0 -1
  54. package/dist/__tests__/step3-contract.test.d.cts +0 -2
  55. package/dist/__tests__/step3-contract.test.d.cts.map +0 -1
  56. package/dist/__tests__/step4-ci.test.d.cts +0 -2
  57. package/dist/__tests__/step4-ci.test.d.cts.map +0 -1
  58. package/dist/__tests__/step5-regres.test.d.cts +0 -2
  59. package/dist/__tests__/step5-regres.test.d.cts.map +0 -1
  60. package/dist/code/templates/complexComponent.d.ts +0 -2
  61. package/dist/code/templates/complexComponent.d.ts.map +0 -1
  62. package/dist/code/templates/complexContainerComponent.d.ts +0 -2
  63. package/dist/code/templates/complexContainerComponent.d.ts.map +0 -1
  64. package/dist/code/templates/simpleComponent.d.ts +0 -2
  65. package/dist/code/templates/simpleComponent.d.ts.map +0 -1
  66. package/dist/code/templates/simpleContainerComponent.d.ts +0 -2
  67. package/dist/code/templates/simpleContainerComponent.d.ts.map +0 -1
  68. package/dist/create.d.ts +0 -3
  69. package/dist/create.d.ts.map +0 -1
  70. package/dist/create.js +0 -162
package/README.md CHANGED
@@ -91,6 +91,18 @@ Type exports:
91
91
 
92
92
  ## CLI Template Scaffolding
93
93
 
94
+ Create a fresh Next.js app and initialize PieUI in it:
95
+
96
+ ```sh
97
+ bunx pieui create my-app-name
98
+ ```
99
+
100
+ This command:
101
+
102
+ - runs `bun create next-app@latest my-app-name --yes`
103
+ - initializes `piecomponents/registry.ts` and PieUI config in the new app
104
+ - prepares the app for `bunx pieui card add ...`
105
+
94
106
  Create a blank Next.js web app template with PieUI CLI:
95
107
 
96
108
  ```sh
@@ -115,3 +127,39 @@ Planned create flow target:
115
127
  ```sh
116
128
  bun create pieui@latest my-pie-app
117
129
  ```
130
+
131
+ Create a page scaffold inside an existing Next app:
132
+
133
+ ```sh
134
+ bunx pieui page add chat
135
+ ```
136
+
137
+ This command writes `app/chat/page.tsx` with the standard Suspense-wrapped Pie page shell:
138
+
139
+ ```tsx
140
+ "use client";
141
+
142
+ import PiePage from "@/app/_shared/simple";
143
+ import { Suspense } from "react";
144
+ import LoadingScreen from "@/components/LoadingScreen";
145
+
146
+ export default function ChatPage() {
147
+ return (
148
+ <Suspense fallback={<LoadingScreen />}>
149
+ <PiePage />
150
+ </Suspense>
151
+ );
152
+ }
153
+ ```
154
+
155
+ Create a component scaffold inside `piecomponents/`:
156
+
157
+ ```sh
158
+ bunx pieui card add simple StatusCard
159
+ ```
160
+
161
+ Add optional realtime and AJAX fields to the generated `types/index.ts`:
162
+
163
+ ```sh
164
+ bunx pieui card add simple LiveCard --io --ajax
165
+ ```