@simplysm/sd-claude 14.0.50 → 14.0.52

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 (318) hide show
  1. package/claude/references/sd-frontend-design.md +10 -9
  2. package/claude/references/sd-simplysm-v14/angular/README.md +497 -0
  3. package/claude/references/sd-simplysm-v14/angular/bootstrap/provide-sd-angular.md +37 -0
  4. package/claude/references/sd-simplysm-v14/angular/bootstrap/sd-angular-config-provider.md +16 -0
  5. package/claude/references/sd-simplysm-v14/angular/directives/sd-command-directive.md +27 -0
  6. package/claude/references/sd-simplysm-v14/angular/directives/sd-events.md +25 -0
  7. package/claude/references/sd-simplysm-v14/angular/directives/sd-intersection-directive.md +36 -0
  8. package/claude/references/sd-simplysm-v14/angular/directives/sd-invalid.md +24 -0
  9. package/claude/references/sd-simplysm-v14/angular/directives/sd-resize-directive.md +42 -0
  10. package/claude/references/sd-simplysm-v14/angular/directives/sd-ripple.md +23 -0
  11. package/claude/references/sd-simplysm-v14/angular/directives/sd-router-link.md +38 -0
  12. package/claude/references/sd-simplysm-v14/angular/directives/sd-show-effect.md +18 -0
  13. package/claude/references/sd-simplysm-v14/angular/directives/sd-typed-template.md +69 -0
  14. package/claude/references/sd-simplysm-v14/angular/features/sd-address-search-modal.md +50 -0
  15. package/claude/references/sd-simplysm-v14/angular/features/sd-permission-table.md +20 -0
  16. package/claude/references/sd-simplysm-v14/angular/features/sd-shared-data-components.md +158 -0
  17. package/claude/references/sd-simplysm-v14/angular/features/sd-tiptap-editor.md +26 -0
  18. package/claude/references/sd-simplysm-v14/angular/pipes/format-pipe.md +41 -0
  19. package/claude/references/sd-simplysm-v14/angular/plugins/sd-global-error-handler.md +23 -0
  20. package/claude/references/sd-simplysm-v14/angular/plugins/sd-option-event-plugin.md +34 -0
  21. package/claude/references/sd-simplysm-v14/angular/provider-types/sd-menu.md +65 -0
  22. package/claude/references/sd-simplysm-v14/angular/provider-types/sd-modal-content-def.md +148 -0
  23. package/claude/references/sd-simplysm-v14/angular/provider-types/sd-toast-content-def.md +73 -0
  24. package/claude/references/sd-simplysm-v14/angular/provider-types/shared-data-base.md +59 -0
  25. package/claude/references/sd-simplysm-v14/angular/providers/sd-activated-modal-provider.md +34 -0
  26. package/claude/references/sd-simplysm-v14/angular/providers/sd-app-structure-provider.md +81 -0
  27. package/claude/references/sd-simplysm-v14/angular/providers/sd-busy-provider.md +18 -0
  28. package/claude/references/sd-simplysm-v14/angular/providers/sd-file-dialog-provider.md +40 -0
  29. package/claude/references/sd-simplysm-v14/angular/providers/sd-local-storage-provider.md +20 -0
  30. package/claude/references/sd-simplysm-v14/angular/providers/sd-modal-provider.md +67 -0
  31. package/claude/references/sd-simplysm-v14/angular/providers/sd-navigate-window-provider.md +18 -0
  32. package/claude/references/sd-simplysm-v14/angular/providers/sd-print-provider.md +25 -0
  33. package/claude/references/sd-simplysm-v14/angular/providers/sd-service-client-factory-provider.md +43 -0
  34. package/claude/references/sd-simplysm-v14/angular/providers/sd-shared-data-provider.md +64 -0
  35. package/claude/references/sd-simplysm-v14/angular/providers/sd-system-config-provider.md +46 -0
  36. package/claude/references/sd-simplysm-v14/angular/providers/sd-system-log-provider.md +18 -0
  37. package/claude/references/sd-simplysm-v14/angular/providers/sd-theme-provider.md +38 -0
  38. package/claude/references/sd-simplysm-v14/angular/providers/sd-toast-provider.md +65 -0
  39. package/claude/references/sd-simplysm-v14/angular/recipes/_common-rules.md +336 -0
  40. package/claude/references/sd-simplysm-v14/angular/recipes/crud-detail/extension-a-edit-save.md +191 -0
  41. package/claude/references/sd-simplysm-v14/angular/recipes/crud-detail/extension-b-delete-restore.md +103 -0
  42. package/claude/references/sd-simplysm-v14/angular/recipes/crud-detail/extension-c-modal-view.md +198 -0
  43. package/claude/references/sd-simplysm-v14/angular/recipes/crud-detail/extension-d-control-view.md +109 -0
  44. package/claude/references/sd-simplysm-v14/angular/recipes/crud-detail/extension-e-auxiliary.md +87 -0
  45. package/claude/references/sd-simplysm-v14/angular/recipes/crud-detail/extension-f-complex-detail.md +202 -0
  46. package/claude/references/sd-simplysm-v14/angular/recipes/crud-detail.md +280 -0
  47. package/claude/references/sd-simplysm-v14/angular/recipes/crud-list/extension-a-inline-edit.md +386 -0
  48. package/claude/references/sd-simplysm-v14/angular/recipes/crud-list/extension-b-selection.md +215 -0
  49. package/claude/references/sd-simplysm-v14/angular/recipes/crud-list/extension-c-inline-delete.md +64 -0
  50. package/claude/references/sd-simplysm-v14/angular/recipes/crud-list/extension-d-select-modal.md +193 -0
  51. package/claude/references/sd-simplysm-v14/angular/recipes/crud-list/extension-e-readonly-modal.md +140 -0
  52. package/claude/references/sd-simplysm-v14/angular/recipes/crud-list/extension-f-modal-edit.md +123 -0
  53. package/claude/references/sd-simplysm-v14/angular/recipes/crud-list/extension-g-excel.md +145 -0
  54. package/claude/references/sd-simplysm-v14/angular/recipes/crud-list.md +377 -0
  55. package/claude/references/sd-simplysm-v14/angular/recipes/data-select-button.md +368 -0
  56. package/claude/references/sd-simplysm-v14/angular/recipes/page-modal-container.md +238 -0
  57. package/claude/references/sd-simplysm-v14/angular/styling/classes.md +149 -0
  58. package/claude/references/sd-simplysm-v14/angular/styling/mixins.md +100 -0
  59. package/claude/references/sd-simplysm-v14/angular/styling/themes.md +35 -0
  60. package/claude/references/sd-simplysm-v14/angular/styling/variables.md +147 -0
  61. package/claude/references/sd-simplysm-v14/angular/type-utilities/directive-input-signals.md +232 -0
  62. package/claude/references/sd-simplysm-v14/angular/ui-data/sd-list.md +37 -0
  63. package/claude/references/sd-simplysm-v14/angular/ui-data/sd-sheet.md +212 -0
  64. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-additional-button.md +26 -0
  65. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-anchor.md +31 -0
  66. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-button.md +103 -0
  67. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-checkbox-group.md +39 -0
  68. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-checkbox.md +81 -0
  69. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-date-range-picker.md +27 -0
  70. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-form.md +89 -0
  71. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-modal-select-button.md +54 -0
  72. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-numpad.md +26 -0
  73. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-range.md +26 -0
  74. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-select.md +68 -0
  75. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-shared-data-select.md +52 -0
  76. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-state-preset.md +37 -0
  77. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-switch.md +27 -0
  78. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-textarea.md +33 -0
  79. package/claude/references/sd-simplysm-v14/angular/ui-form/sd-textfield.md +145 -0
  80. package/claude/references/sd-simplysm-v14/angular/ui-layout/sd-dock-container.md +64 -0
  81. package/claude/references/sd-simplysm-v14/angular/ui-layout/sd-dock.md +37 -0
  82. package/claude/references/sd-simplysm-v14/angular/ui-layout/sd-gap.md +26 -0
  83. package/claude/references/sd-simplysm-v14/angular/ui-layout/sd-kanban-board.md +96 -0
  84. package/claude/references/sd-simplysm-v14/angular/ui-layout/sd-kanban-lane.md +34 -0
  85. package/claude/references/sd-simplysm-v14/angular/ui-layout/sd-kanban.md +29 -0
  86. package/claude/references/sd-simplysm-v14/angular/ui-navigation/sd-collapse.md +35 -0
  87. package/claude/references/sd-simplysm-v14/angular/ui-navigation/sd-pagination.md +26 -0
  88. package/claude/references/sd-simplysm-v14/angular/ui-navigation/sd-sidebar-container.md +49 -0
  89. package/claude/references/sd-simplysm-v14/angular/ui-navigation/sd-sidebar-menu.md +22 -0
  90. package/claude/references/sd-simplysm-v14/angular/ui-navigation/sd-sidebar-user.md +43 -0
  91. package/claude/references/sd-simplysm-v14/angular/ui-navigation/sd-tab.md +51 -0
  92. package/claude/references/sd-simplysm-v14/angular/ui-navigation/sd-topbar-container.md +97 -0
  93. package/claude/references/sd-simplysm-v14/angular/ui-navigation/sd-topbar-menu.md +23 -0
  94. package/claude/references/sd-simplysm-v14/angular/ui-navigation/sd-topbar-user.md +38 -0
  95. package/claude/references/sd-simplysm-v14/angular/ui-navigation/sd-topbar.md +30 -0
  96. package/claude/references/sd-simplysm-v14/angular/ui-overlay/sd-busy-container.md +69 -0
  97. package/claude/references/sd-simplysm-v14/angular/ui-overlay/sd-confirm-modal.md +30 -0
  98. package/claude/references/sd-simplysm-v14/angular/ui-overlay/sd-dropdown.md +40 -0
  99. package/claude/references/sd-simplysm-v14/angular/ui-overlay/sd-modal.md +34 -0
  100. package/claude/references/sd-simplysm-v14/angular/ui-overlay/sd-prompt-modal.md +30 -0
  101. package/claude/references/sd-simplysm-v14/angular/ui-overlay/sd-toast.md +35 -0
  102. package/claude/references/sd-simplysm-v14/angular/ui-visual/sd-barcode.md +36 -0
  103. package/claude/references/sd-simplysm-v14/angular/ui-visual/sd-calendar.md +34 -0
  104. package/claude/references/sd-simplysm-v14/angular/ui-visual/sd-echarts.md +32 -0
  105. package/claude/references/sd-simplysm-v14/angular/ui-visual/sd-label.md +24 -0
  106. package/claude/references/sd-simplysm-v14/angular/ui-visual/sd-note.md +23 -0
  107. package/claude/references/sd-simplysm-v14/angular/ui-visual/sd-progress.md +23 -0
  108. package/claude/references/sd-simplysm-v14/angular/utils/inject-routing-signals.md +161 -0
  109. package/claude/references/sd-simplysm-v14/angular/utils/inject-sd-system-config-resource.md +35 -0
  110. package/claude/references/sd-simplysm-v14/angular/utils/mark.md +43 -0
  111. package/claude/references/sd-simplysm-v14/angular/utils/selection-managers.md +96 -0
  112. package/claude/references/sd-simplysm-v14/angular/utils/set-safe-style.md +19 -0
  113. package/claude/references/sd-simplysm-v14/angular/utils/setup-functions.md +93 -0
  114. package/claude/references/sd-simplysm-v14/capacitor-plugin-auto-update/README.md +38 -0
  115. package/claude/references/sd-simplysm-v14/capacitor-plugin-auto-update/apk-installer/apk-installer.md +115 -0
  116. package/claude/references/sd-simplysm-v14/capacitor-plugin-auto-update/auto-update/auto-update.md +113 -0
  117. package/claude/references/sd-simplysm-v14/capacitor-plugin-file-system/README.md +197 -0
  118. package/claude/references/sd-simplysm-v14/capacitor-plugin-intent/README.md +235 -0
  119. package/claude/references/sd-simplysm-v14/capacitor-plugin-usb-storage/README.md +251 -0
  120. package/claude/references/sd-simplysm-v14/core-browser/README.md +52 -0
  121. package/claude/references/sd-simplysm-v14/core-browser/extensions/copy-paste.md +59 -0
  122. package/claude/references/sd-simplysm-v14/core-browser/extensions/element-prototype-extensions.md +137 -0
  123. package/claude/references/sd-simplysm-v14/core-browser/extensions/get-bounds.md +84 -0
  124. package/claude/references/sd-simplysm-v14/core-browser/utils/download-blob.md +59 -0
  125. package/claude/references/sd-simplysm-v14/core-browser/utils/fetch-url-bytes.md +91 -0
  126. package/claude/references/sd-simplysm-v14/core-browser/utils/indexed-db-store.md +131 -0
  127. package/claude/references/sd-simplysm-v14/core-browser/utils/indexed-db-virtual-fs.md +121 -0
  128. package/claude/references/sd-simplysm-v14/core-browser/utils/open-file-dialog.md +60 -0
  129. package/claude/references/sd-simplysm-v14/core-common/README.md +179 -0
  130. package/claude/references/sd-simplysm-v14/core-common/errors/argument-error.md +26 -0
  131. package/claude/references/sd-simplysm-v14/core-common/errors/not-implemented-error.md +33 -0
  132. package/claude/references/sd-simplysm-v14/core-common/errors/sd-error.md +38 -0
  133. package/claude/references/sd-simplysm-v14/core-common/errors/timeout-error.md +36 -0
  134. package/claude/references/sd-simplysm-v14/core-common/extensions/array.md +125 -0
  135. package/claude/references/sd-simplysm-v14/core-common/extensions/map.md +43 -0
  136. package/claude/references/sd-simplysm-v14/core-common/extensions/set.md +35 -0
  137. package/claude/references/sd-simplysm-v14/core-common/features/debounce-queue.md +48 -0
  138. package/claude/references/sd-simplysm-v14/core-common/features/event-emitter.md +52 -0
  139. package/claude/references/sd-simplysm-v14/core-common/features/serial-queue.md +44 -0
  140. package/claude/references/sd-simplysm-v14/core-common/type-utils/common-types.md +100 -0
  141. package/claude/references/sd-simplysm-v14/core-common/type-utils/env.md +42 -0
  142. package/claude/references/sd-simplysm-v14/core-common/types/date-only.md +86 -0
  143. package/claude/references/sd-simplysm-v14/core-common/types/date-time.md +106 -0
  144. package/claude/references/sd-simplysm-v14/core-common/types/lazy-gc-map.md +59 -0
  145. package/claude/references/sd-simplysm-v14/core-common/types/time.md +62 -0
  146. package/claude/references/sd-simplysm-v14/core-common/types/uuid.md +41 -0
  147. package/claude/references/sd-simplysm-v14/core-common/utils/bytes.md +36 -0
  148. package/claude/references/sd-simplysm-v14/core-common/utils/dt.md +60 -0
  149. package/claude/references/sd-simplysm-v14/core-common/utils/err.md +26 -0
  150. package/claude/references/sd-simplysm-v14/core-common/utils/json.md +58 -0
  151. package/claude/references/sd-simplysm-v14/core-common/utils/num.md +56 -0
  152. package/claude/references/sd-simplysm-v14/core-common/utils/obj.md +107 -0
  153. package/claude/references/sd-simplysm-v14/core-common/utils/path.md +30 -0
  154. package/claude/references/sd-simplysm-v14/core-common/utils/primitive.md +28 -0
  155. package/claude/references/sd-simplysm-v14/core-common/utils/str.md +63 -0
  156. package/claude/references/sd-simplysm-v14/core-common/utils/template-strings.md +49 -0
  157. package/claude/references/sd-simplysm-v14/core-common/utils/transfer.md +35 -0
  158. package/claude/references/sd-simplysm-v14/core-common/utils/wait.md +35 -0
  159. package/claude/references/sd-simplysm-v14/core-common/utils/xml.md +49 -0
  160. package/claude/references/sd-simplysm-v14/core-common/utils/zip-archive.md +77 -0
  161. package/claude/references/sd-simplysm-v14/core-node/README.md +59 -0
  162. package/claude/references/sd-simplysm-v14/core-node/features/fs-watcher.md +110 -0
  163. package/claude/references/sd-simplysm-v14/core-node/logging/create-file-reporter.md +78 -0
  164. package/claude/references/sd-simplysm-v14/core-node/logging/pretty-reporter.md +38 -0
  165. package/claude/references/sd-simplysm-v14/core-node/logging/setup-consola.md +77 -0
  166. package/claude/references/sd-simplysm-v14/core-node/utils/cpx.md +128 -0
  167. package/claude/references/sd-simplysm-v14/core-node/utils/fsx.md +168 -0
  168. package/claude/references/sd-simplysm-v14/core-node/utils/pathx.md +73 -0
  169. package/claude/references/sd-simplysm-v14/core-node/worker/create-worker.md +85 -0
  170. package/claude/references/sd-simplysm-v14/core-node/worker/worker.md +160 -0
  171. package/claude/references/sd-simplysm-v14/excel/README.md +66 -0
  172. package/claude/references/sd-simplysm-v14/excel/core-classes/excel-cell.md +79 -0
  173. package/claude/references/sd-simplysm-v14/excel/core-classes/excel-col.md +36 -0
  174. package/claude/references/sd-simplysm-v14/excel/core-classes/excel-row.md +34 -0
  175. package/claude/references/sd-simplysm-v14/excel/core-classes/excel-workbook.md +93 -0
  176. package/claude/references/sd-simplysm-v14/excel/core-classes/excel-worksheet.md +147 -0
  177. package/claude/references/sd-simplysm-v14/excel/types/excel-address-point.md +33 -0
  178. package/claude/references/sd-simplysm-v14/excel/types/excel-style-options.md +57 -0
  179. package/claude/references/sd-simplysm-v14/excel/types/excel-value-type.md +28 -0
  180. package/claude/references/sd-simplysm-v14/excel/types/excel-xml-content-type-data.md +23 -0
  181. package/claude/references/sd-simplysm-v14/excel/types/excel-xml-drawing-data.md +29 -0
  182. package/claude/references/sd-simplysm-v14/excel/types/excel-xml-relationship-data.md +39 -0
  183. package/claude/references/sd-simplysm-v14/excel/types/excel-xml-shared-string-data.md +42 -0
  184. package/claude/references/sd-simplysm-v14/excel/types/excel-xml-style-data.md +97 -0
  185. package/claude/references/sd-simplysm-v14/excel/types/excel-xml-workbook-data.md +22 -0
  186. package/claude/references/sd-simplysm-v14/excel/types/excel-xml-worksheet-data.md +68 -0
  187. package/claude/references/sd-simplysm-v14/excel/types/excel-xml.md +15 -0
  188. package/claude/references/sd-simplysm-v14/excel/utilities/excel-utils.md +101 -0
  189. package/claude/references/sd-simplysm-v14/excel/wrapper/excel-wrapper.md +108 -0
  190. package/claude/references/sd-simplysm-v14/lint/README.md +183 -0
  191. package/claude/references/sd-simplysm-v14/orm-common/README.md +156 -0
  192. package/claude/references/sd-simplysm-v14/orm-common/core/db-context.md +208 -0
  193. package/claude/references/sd-simplysm-v14/orm-common/core/db-transaction-error.md +64 -0
  194. package/claude/references/sd-simplysm-v14/orm-common/expression/expr-unit.md +62 -0
  195. package/claude/references/sd-simplysm-v14/orm-common/expression/expr.md +198 -0
  196. package/claude/references/sd-simplysm-v14/orm-common/models/migration.md +37 -0
  197. package/claude/references/sd-simplysm-v14/orm-common/query-builder/create-query-builder.md +80 -0
  198. package/claude/references/sd-simplysm-v14/orm-common/queryable-executable/executable.md +54 -0
  199. package/claude/references/sd-simplysm-v14/orm-common/queryable-executable/parse-search-query.md +75 -0
  200. package/claude/references/sd-simplysm-v14/orm-common/queryable-executable/queryable.md +238 -0
  201. package/claude/references/sd-simplysm-v14/orm-common/schema-builders/column-builder.md +63 -0
  202. package/claude/references/sd-simplysm-v14/orm-common/schema-builders/foreign-key-builder.md +137 -0
  203. package/claude/references/sd-simplysm-v14/orm-common/schema-builders/index-builder.md +54 -0
  204. package/claude/references/sd-simplysm-v14/orm-common/schema-builders/procedure.md +67 -0
  205. package/claude/references/sd-simplysm-v14/orm-common/schema-builders/table.md +95 -0
  206. package/claude/references/sd-simplysm-v14/orm-common/schema-builders/view.md +71 -0
  207. package/claude/references/sd-simplysm-v14/orm-common/types/data-type.md +146 -0
  208. package/claude/references/sd-simplysm-v14/orm-common/types/dialect.md +151 -0
  209. package/claude/references/sd-simplysm-v14/orm-common/types/expr.md +175 -0
  210. package/claude/references/sd-simplysm-v14/orm-common/types/parse-query-result.md +58 -0
  211. package/claude/references/sd-simplysm-v14/orm-common/types/query-def.md +224 -0
  212. package/claude/references/sd-simplysm-v14/orm-node/README.md +65 -0
  213. package/claude/references/sd-simplysm-v14/orm-node/connections/mssql-db-conn.md +85 -0
  214. package/claude/references/sd-simplysm-v14/orm-node/connections/mysql-db-conn.md +83 -0
  215. package/claude/references/sd-simplysm-v14/orm-node/connections/postgresql-db-conn.md +86 -0
  216. package/claude/references/sd-simplysm-v14/orm-node/core/create-db-conn.md +62 -0
  217. package/claude/references/sd-simplysm-v14/orm-node/core/create-orm.md +107 -0
  218. package/claude/references/sd-simplysm-v14/orm-node/core/node-db-context-executor.md +50 -0
  219. package/claude/references/sd-simplysm-v14/orm-node/types/db-conn-config.md +91 -0
  220. package/claude/references/sd-simplysm-v14/orm-node/types/db-conn-constants.md +33 -0
  221. package/claude/references/sd-simplysm-v14/orm-node/types/db-conn.md +60 -0
  222. package/claude/references/sd-simplysm-v14/orm-node/types/get-dialect-from-config.md +17 -0
  223. package/{README.md → claude/references/sd-simplysm-v14/sd-claude/README.md} +85 -84
  224. package/{docs → claude/references/sd-simplysm-v14/sd-claude}/assets.md +2 -2
  225. package/{docs → claude/references/sd-simplysm-v14/sd-claude}/hooks.md +15 -1
  226. package/claude/references/sd-simplysm-v14/sd-cli/README.md +138 -0
  227. package/claude/references/sd-simplysm-v14/sd-cli/angular-vite-plugin/sd-angular-plugin.md +60 -0
  228. package/claude/references/sd-simplysm-v14/sd-cli/config/build-target.md +31 -0
  229. package/claude/references/sd-simplysm-v14/sd-cli/config/npm-config.md +27 -0
  230. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-browser-support-config.md +19 -0
  231. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-build-package-config.md +21 -0
  232. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-capacitor-config.md +109 -0
  233. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-client-package-config.md +33 -0
  234. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-config.md +78 -0
  235. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-electron-config.md +27 -0
  236. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-package-config.md +18 -0
  237. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-post-publish-script-config.md +19 -0
  238. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-publish-config.md +72 -0
  239. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-pwa-config.md +41 -0
  240. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-scripts-package-config.md +19 -0
  241. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-server-package-config.md +32 -0
  242. package/claude/references/sd-simplysm-v14/sd-cli/config/sd-watch-hook-config.md +19 -0
  243. package/claude/references/sd-simplysm-v14/sd-cli/ts-compiler/sd-ts-compiler.md +158 -0
  244. package/claude/references/sd-simplysm-v14/service-client/README.md +74 -0
  245. package/claude/references/sd-simplysm-v14/service-client/features/event-client.md +93 -0
  246. package/claude/references/sd-simplysm-v14/service-client/features/file-client.md +63 -0
  247. package/claude/references/sd-simplysm-v14/service-client/features/orm-client-connector.md +89 -0
  248. package/claude/references/sd-simplysm-v14/service-client/features/orm-client-db-context-executor.md +31 -0
  249. package/claude/references/sd-simplysm-v14/service-client/main/service-client.md +206 -0
  250. package/claude/references/sd-simplysm-v14/service-client/protocol/client-protocol-wrapper.md +64 -0
  251. package/claude/references/sd-simplysm-v14/service-client/transport/service-transport.md +68 -0
  252. package/claude/references/sd-simplysm-v14/service-client/transport/socket-provider.md +100 -0
  253. package/claude/references/sd-simplysm-v14/service-client/types/blob-input.md +7 -0
  254. package/claude/references/sd-simplysm-v14/service-client/types/browser-worker.md +47 -0
  255. package/claude/references/sd-simplysm-v14/service-client/types/file-collection.md +21 -0
  256. package/claude/references/sd-simplysm-v14/service-client/types/service-connection-options.md +22 -0
  257. package/claude/references/sd-simplysm-v14/service-client/types/service-progress.md +39 -0
  258. package/claude/references/sd-simplysm-v14/service-common/README.md +161 -0
  259. package/claude/references/sd-simplysm-v14/service-common/app-structure/app-structure-item.md +107 -0
  260. package/claude/references/sd-simplysm-v14/service-common/app-structure/get-flat-permissions.md +57 -0
  261. package/claude/references/sd-simplysm-v14/service-common/app-structure/is-usable-modules-chain.md +23 -0
  262. package/claude/references/sd-simplysm-v14/service-common/app-structure/is-usable-modules.md +42 -0
  263. package/claude/references/sd-simplysm-v14/service-common/events/define-event.md +68 -0
  264. package/claude/references/sd-simplysm-v14/service-common/protocol/create-service-protocol.md +93 -0
  265. package/claude/references/sd-simplysm-v14/service-common/protocol/protocol-config.md +21 -0
  266. package/claude/references/sd-simplysm-v14/service-common/protocol/service-add-event-listener-message.md +23 -0
  267. package/claude/references/sd-simplysm-v14/service-common/protocol/service-auth-message.md +17 -0
  268. package/claude/references/sd-simplysm-v14/service-common/protocol/service-emit-event-message.md +21 -0
  269. package/claude/references/sd-simplysm-v14/service-common/protocol/service-error-message.md +29 -0
  270. package/claude/references/sd-simplysm-v14/service-common/protocol/service-event-message.md +21 -0
  271. package/claude/references/sd-simplysm-v14/service-common/protocol/service-get-event-listener-infos-message.md +19 -0
  272. package/claude/references/sd-simplysm-v14/service-common/protocol/service-message.md +52 -0
  273. package/claude/references/sd-simplysm-v14/service-common/protocol/service-progress-message.md +21 -0
  274. package/claude/references/sd-simplysm-v14/service-common/protocol/service-remove-event-listener-message.md +19 -0
  275. package/claude/references/sd-simplysm-v14/service-common/protocol/service-request-message.md +17 -0
  276. package/claude/references/sd-simplysm-v14/service-common/protocol/service-response-message.md +17 -0
  277. package/claude/references/sd-simplysm-v14/service-common/service-types/app-structure-service.md +15 -0
  278. package/claude/references/sd-simplysm-v14/service-common/service-types/auto-update-service.md +20 -0
  279. package/claude/references/sd-simplysm-v14/service-common/service-types/orm-service.md +61 -0
  280. package/claude/references/sd-simplysm-v14/service-common/types/service-upload-result.md +19 -0
  281. package/claude/references/sd-simplysm-v14/service-server/README.md +162 -0
  282. package/claude/references/sd-simplysm-v14/service-server/auth/auth-token-payload.md +18 -0
  283. package/claude/references/sd-simplysm-v14/service-server/auth/sign-jwt.md +30 -0
  284. package/claude/references/sd-simplysm-v14/service-server/auth/verify-jwt.md +35 -0
  285. package/claude/references/sd-simplysm-v14/service-server/core/auth.md +64 -0
  286. package/claude/references/sd-simplysm-v14/service-server/core/define-service.md +81 -0
  287. package/claude/references/sd-simplysm-v14/service-server/core/execute-service-method.md +43 -0
  288. package/claude/references/sd-simplysm-v14/service-server/core/service-context.md +79 -0
  289. package/claude/references/sd-simplysm-v14/service-server/legacy/handle-v1-connection.md +25 -0
  290. package/claude/references/sd-simplysm-v14/service-server/main/create-service-server.md +32 -0
  291. package/claude/references/sd-simplysm-v14/service-server/main/service-server.md +113 -0
  292. package/claude/references/sd-simplysm-v14/service-server/protocol/server-protocol-wrapper.md +35 -0
  293. package/claude/references/sd-simplysm-v14/service-server/services/app-structure-service.md +59 -0
  294. package/claude/references/sd-simplysm-v14/service-server/services/auto-update-service.md +34 -0
  295. package/claude/references/sd-simplysm-v14/service-server/services/orm-service.md +43 -0
  296. package/claude/references/sd-simplysm-v14/service-server/transport-http/handle-http-request.md +33 -0
  297. package/claude/references/sd-simplysm-v14/service-server/transport-http/handle-static-file.md +29 -0
  298. package/claude/references/sd-simplysm-v14/service-server/transport-http/handle-upload.md +33 -0
  299. package/claude/references/sd-simplysm-v14/service-server/transport-socket/service-socket.md +64 -0
  300. package/claude/references/sd-simplysm-v14/service-server/transport-socket/websocket-handler.md +57 -0
  301. package/claude/references/sd-simplysm-v14/service-server/types/service-server-options.md +36 -0
  302. package/claude/references/sd-simplysm-v14/service-server/utils/get-config.md +29 -0
  303. package/claude/references/sd-simplysm-v14/storage/README.md +99 -0
  304. package/claude/references/sd-simplysm-v14/storage/clients/ftp-storage-client.md +99 -0
  305. package/claude/references/sd-simplysm-v14/storage/clients/sftp-storage-client.md +108 -0
  306. package/claude/references/sd-simplysm-v14/storage/factory/storage-factory.md +114 -0
  307. package/claude/references/sd-simplysm-v14/storage/types/file-info.md +32 -0
  308. package/claude/references/sd-simplysm-v14/storage/types/storage-client.md +55 -0
  309. package/claude/references/sd-simplysm-v14/storage/types/storage-conn-config.md +34 -0
  310. package/claude/rules/sd-claude-rules.md +8 -8
  311. package/claude/rules/sd-simplysm-v14.md +33 -0
  312. package/claude/skills/sd-claude-docs/SKILL.md +41 -24
  313. package/claude/skills/sd-claude-docs/references/package-docs.md +240 -116
  314. package/claude/skills/sd-inner-debug/SKILL.md +1 -1
  315. package/claude/skills/sd-inner-review/SKILL.md +4 -2
  316. package/package.json +2 -3
  317. /package/{docs → claude/references/sd-simplysm-v14/sd-claude}/cli.md +0 -0
  318. /package/{docs → claude/references/sd-simplysm-v14/sd-claude}/scripts.md +0 -0
@@ -0,0 +1,41 @@
1
+ # SdPwaConfig
2
+
3
+ PWA(Progressive Web App) 설정. [`SdClientPackageConfig`](./sd-client-package-config.md)의 `pwa` 필드에 사용한다.
4
+
5
+ ```typescript
6
+ export interface SdPwaConfig {
7
+ manifest?: SdPwaManifestConfig;
8
+ }
9
+ ```
10
+
11
+ ## Members
12
+
13
+ | Field | Type | Description |
14
+ |-------|------|-------------|
15
+ | `manifest` | `SdPwaManifestConfig?` | PWA manifest 설정 |
16
+
17
+ ## Related Types
18
+
19
+ ### `SdPwaManifestConfig`
20
+
21
+ PWA `manifest.json` 설정.
22
+
23
+ ```typescript
24
+ export interface SdPwaManifestConfig {
25
+ name?: string;
26
+ short_name?: string;
27
+ display?: "standalone" | "fullscreen" | "minimal-ui" | "browser";
28
+ theme_color?: string;
29
+ background_color?: string;
30
+ icons?: Array<{ src: string; sizes: string; type?: string }>;
31
+ }
32
+ ```
33
+
34
+ | Field | Type | Description |
35
+ |-------|------|-------------|
36
+ | `name` | `string?` | 앱 이름 |
37
+ | `short_name` | `string?` | 앱 짧은 이름 |
38
+ | `display` | `"standalone" \| "fullscreen" \| "minimal-ui" \| "browser"?` | 디스플레이 모드 |
39
+ | `theme_color` | `string?` | 테마 색상 (hex 코드) |
40
+ | `background_color` | `string?` | 배경 색상 (hex 코드) |
41
+ | `icons` | `Array<{ src: string; sizes: string; type?: string }>?` | 아이콘 목록 |
@@ -0,0 +1,19 @@
1
+ # SdScriptsPackageConfig
2
+
3
+ `scripts` 타겟 패키지 설정. 빌드 엔진이 없으며, `watch` 훅이 설정된 경우에만 watch/typecheck 대상에 포함된다.
4
+
5
+ ```typescript
6
+ export interface SdScriptsPackageConfig {
7
+ target: "scripts";
8
+ publish?: SdPublishConfig;
9
+ watch?: SdWatchHookConfig;
10
+ }
11
+ ```
12
+
13
+ ## Members
14
+
15
+ | Field | Type | Description |
16
+ |-------|------|-------------|
17
+ | `target` | `"scripts"` | 빌드 타겟 식별자 |
18
+ | `publish` | [`SdPublishConfig?`](./sd-publish-config.md) | 배포 설정 |
19
+ | `watch` | [`SdWatchHookConfig?`](./sd-watch-hook-config.md) | watch 훅 설정. 설정 시 watch 모드에 패키지가 포함된다 |
@@ -0,0 +1,32 @@
1
+ # SdServerPackageConfig
2
+
3
+ `server` 타겟 패키지 설정. esbuild로 단일 번들 빌드되며 Fastify 서버로 실행된다.
4
+
5
+ ```typescript
6
+ export interface SdServerPackageConfig {
7
+ target: "server";
8
+ env?: Record<string, string>;
9
+ publish?: SdPublishConfig;
10
+ configs?: Record<string, unknown>;
11
+ externals?: string[];
12
+ pm2?: {
13
+ name?: string;
14
+ ignoreWatchPaths?: string[];
15
+ };
16
+ packageManager?: "volta" | "mise";
17
+ }
18
+ ```
19
+
20
+ ## Members
21
+
22
+ | Field | Type | Description |
23
+ |-------|------|-------------|
24
+ | `target` | `"server"` | 빌드 타겟 식별자 |
25
+ | `env` | `Record<string, string>?` | 빌드 시 치환할 환경 변수. `process.env.KEY`를 상수로 치환 |
26
+ | `publish` | [`SdPublishConfig?`](./sd-publish-config.md) | 배포 설정 |
27
+ | `configs` | `Record<string, unknown>?` | 런타임 설정. 빌드 시 `dist/.config.json`으로 기록 |
28
+ | `externals` | `string[]?` | esbuild 번들에 포함하지 않을 외부 모듈. 자동 `binding.gyp` 감지 목록에 추가 |
29
+ | `pm2` | `{ name?: string; ignoreWatchPaths?: string[] }?` | PM2 설정. 지정 시 `dist/pm2.config.cjs` 생성 |
30
+ | `pm2.name` | `string?` | PM2 프로세스 이름. 미지정 시 `package.json`의 `name`에서 생성 |
31
+ | `pm2.ignoreWatchPaths` | `string[]?` | PM2 watch에서 제외할 경로 |
32
+ | `packageManager` | `"volta" \| "mise"?` | 사용할 패키지 매니저. `mise.toml` 또는 `volta` 설정 생성에 영향 |
@@ -0,0 +1,19 @@
1
+ # SdWatchHookConfig
2
+
3
+ watch 모드에서 파일 변경을 감지하고 명령어를 실행하는 훅 설정. [`SdBuildPackageConfig`](./sd-build-package-config.md) 및 [`SdScriptsPackageConfig`](./sd-scripts-package-config.md)의 `watch` 필드에 사용한다.
4
+
5
+ ```typescript
6
+ export interface SdWatchHookConfig {
7
+ target: string[];
8
+ cmd: string;
9
+ args?: string[];
10
+ }
11
+ ```
12
+
13
+ ## Members
14
+
15
+ | Field | Type | Description |
16
+ |-------|------|-------------|
17
+ | `target` | `string[]` | 감시할 glob 패턴 목록. 패키지 디렉토리 기준 상대 경로 |
18
+ | `cmd` | `string` | 파일 변경 시 실행할 명령어 |
19
+ | `args` | `string[]?` | 명령어 인수 |
@@ -0,0 +1,158 @@
1
+ # SdTsCompiler
2
+
3
+ TypeScript AOT 컴파일러. Angular 패키지(`angularCompilerOptions`가 `tsconfig.json`에 있는 경우)와 일반 TypeScript 패키지를 모두 지원한다. 증분 빌드, lint 통합, SCSS 컴파일을 관리한다.
4
+
5
+ ## When to use
6
+
7
+ - ✅ Angular/TS 패키지를 프로그래매틱하게 컴파일해야 할 때 (커스텀 빌드 파이프라인, Vite 플러그인 내부 등)
8
+ - ✅ 증분 빌드가 필요한 watch 모드 구현 시
9
+ - ❌ CLI 명령어로 빌드할 때 — `pnpm build`/`pnpm watch` 사용. `SdTsCompiler`는 sd-cli 내부 엔진과 [`sdAngularPlugin`](../angular-vite-plugin/sd-angular-plugin.md)에서 사용하는 저수준 API
10
+
11
+ ```typescript
12
+ export class SdTsCompiler {
13
+ constructor(options: ISdTsCompilerOptions);
14
+
15
+ async compileAsync(
16
+ modifiedFiles?: ReadonlySet<string>,
17
+ emitOptions?: ISdTsCompilerEmitOptions,
18
+ ): Promise<ISdTsCompilerResult>;
19
+
20
+ compileSideEffectScss(): void;
21
+
22
+ findAffectedByScss(scssPath: string): string[];
23
+
24
+ get sideEffectScssRegistry(): Map<string, SideEffectScssEntry>;
25
+ }
26
+ ```
27
+
28
+ ## Members
29
+
30
+ | Member | Kind | Type | Description |
31
+ |--------|------|------|-------------|
32
+ | `compileAsync` | method | `(modifiedFiles?, emitOptions?) => Promise<ISdTsCompilerResult>` | TypeScript 컴파일 실행. `modifiedFiles` 지정 시 증분 빌드 수행 |
33
+ | `compileSideEffectScss` | method | `() => void` | `sideEffectScssRegistry`의 모든 항목을 CSS로 컴파일 |
34
+ | `findAffectedByScss` | method | `(scssPath: string) => string[]` | SCSS 경로에 의존하는 TypeScript 파일 목록 반환. watch 역방향 추적용 |
35
+ | `sideEffectScssRegistry` | getter | `Map<string, SideEffectScssEntry>` | Angular 컴포넌트 `@Component.styles` 항목 저장소 |
36
+
37
+ ## Related Types
38
+
39
+ ### `ISdTsCompilerOptions`
40
+
41
+ `SdTsCompiler` 생성 옵션.
42
+
43
+ ```typescript
44
+ export interface ISdTsCompilerOptions {
45
+ pkgDir: string;
46
+ cwd: string;
47
+ output: { js: boolean; dts: boolean };
48
+ includeTests?: boolean;
49
+ env?: TypecheckEnv;
50
+ sourceFileCache?: AngularSourceFileCache;
51
+ transformStylesheet?: (
52
+ data: string,
53
+ containingFile: string,
54
+ stylesheetFile?: string,
55
+ ) => Promise<string | null>;
56
+ externalStylesheets?: Map<string, string>;
57
+ compilerOptionsTransformer?: (options: ts.CompilerOptions) => ts.CompilerOptions;
58
+ lint?: boolean;
59
+ globalScss?: boolean;
60
+ }
61
+ ```
62
+
63
+ | Field | Type | Description |
64
+ |-------|------|-------------|
65
+ | `pkgDir` | `string` | 패키지 디렉토리 (절대 경로) |
66
+ | `cwd` | `string` | workspace 루트. diagnostics 필터링 등에 사용 |
67
+ | `output` | `{ js: boolean; dts: boolean }` | emit 제어 플래그. `js`: JavaScript emit, `dts`: 타입 선언 emit |
68
+ | `includeTests` | `boolean?` | `tests/` 파일을 rootNames에 포함할지 여부. 기본값 `false` |
69
+ | `env` | `TypecheckEnv?` | 타입체크 환경. 설정 시 `getCompilerOptionsForEnv()` 적용 |
70
+ | `sourceFileCache` | `AngularSourceFileCache?` | Angular 증분 빌드용 SourceFile 캐시. 미제공 시 내부 생성 |
71
+ | `transformStylesheet` | `(data, containingFile, stylesheetFile?) => Promise<string \| null>?` | 스타일시트 변환 콜백. Angular 패키지 전용 |
72
+ | `externalStylesheets` | `Map<string, string>?` | 외부 스타일시트 맵. 클라이언트 빌드용, `resourceNameToFileName`에서 사용 |
73
+ | `compilerOptionsTransformer` | `(options: ts.CompilerOptions) => ts.CompilerOptions?` | `compilerOptions` 후처리. 클라이언트의 `target`/`module` 강제 등에 사용 |
74
+ | `lint` | `boolean?` | lint 실행 여부. `true`이면 `compileAsync` 결과에 lint 결과 포함 |
75
+ | `globalScss` | `boolean?` | 글로벌 SCSS 컴파일 여부. `true`이면 `scss/styles.scss` → `dist/styles.css` 생성 |
76
+
77
+ ### `ISdTsCompilerResult`
78
+
79
+ `compileAsync()` 반환 타입.
80
+
81
+ ```typescript
82
+ export interface ISdTsCompilerResult {
83
+ program: ts.Program;
84
+ builderProgram: ts.EmitAndSemanticDiagnosticsBuilderProgram;
85
+ isForAngular: boolean;
86
+ affectedFiles: ReadonlySet<string> | undefined;
87
+ diagnostics: SerializedDiagnostic[];
88
+ errorCount: number;
89
+ warningCount: number;
90
+ errors?: string[];
91
+ ngtscProgram?: NgtscProgram;
92
+ emitResults?: EmitResult[];
93
+ lint?: LintWithProgramResult;
94
+ scssErrors: string[];
95
+ scssDependencies: ReadonlyMap<string, ReadonlySet<string>>;
96
+ }
97
+ ```
98
+
99
+ | Field | Type | Description |
100
+ |-------|------|-------------|
101
+ | `program` | `ts.Program` | TypeScript Program 참조. lint, 외부 도구용 |
102
+ | `builderProgram` | `ts.EmitAndSemanticDiagnosticsBuilderProgram` | Builder Program 참조. 증분 빌드 상태 보유 |
103
+ | `isForAngular` | `boolean` | Angular 패키지 여부. `tsconfig.json`에 `angularCompilerOptions` 존재 시 `true` |
104
+ | `affectedFiles` | `ReadonlySet<string> \| undefined` | 이 빌드에서 영향받은 파일 (posix 경로). `undefined` = 전역 변경 (전체 리빌드) |
105
+ | `diagnostics` | `SerializedDiagnostic[]` | 직렬화된 진단 정보. Worker 경계 통과용 |
106
+ | `errorCount` | `number` | Error 카테고리 진단 수 |
107
+ | `warningCount` | `number` | Warning 카테고리 진단 수 |
108
+ | `errors` | `string[]?` | Error 카테고리 진단을 `"파일:줄:열: TS코드: 메시지"` 형식으로 포맷한 배열. 에러 없으면 `undefined` |
109
+ | `ngtscProgram` | `NgtscProgram?` | NgtscProgram 참조. Angular 패키지 전용, HMR용. Non-Angular이면 `undefined` |
110
+ | `emitResults` | `EmitResult[]?` | Angular emit 결과. Non-Angular이면 `undefined` (writeFile 훅으로 디스크 직접 쓰기) |
111
+ | `lint` | `LintWithProgramResult?` | lint 결과. `lint` 옵션 활성 시 반환 |
112
+ | `scssErrors` | `string[]` | SCSS 컴파일 에러 목록 |
113
+ | `scssDependencies` | `ReadonlyMap<string, ReadonlySet<string>>` | SCSS 의존성 맵. key: 소유자 파일, value: 의존 SCSS 경로 집합. watch 역방향 탐색용 |
114
+
115
+ ## Usage
116
+
117
+ ### 초기 컴파일
118
+
119
+ ```typescript
120
+ import { SdTsCompiler } from "@simplysm/sd-cli";
121
+
122
+ const compiler = new SdTsCompiler({
123
+ pkgDir: "/workspace/packages/my-lib",
124
+ cwd: "/workspace",
125
+ output: { js: true, dts: true },
126
+ lint: true,
127
+ globalScss: true,
128
+ });
129
+
130
+ const result = await compiler.compileAsync();
131
+
132
+ if (result.errors) {
133
+ console.error("Compilation errors:", result.errors);
134
+ process.exit(1);
135
+ }
136
+ ```
137
+
138
+ ### watch 모드에서 증분 컴파일
139
+
140
+ ```typescript
141
+ import { SdTsCompiler } from "@simplysm/sd-cli";
142
+
143
+ const compiler = new SdTsCompiler({
144
+ pkgDir: "/workspace/packages/my-lib",
145
+ cwd: "/workspace",
146
+ output: { js: true, dts: true },
147
+ });
148
+
149
+ // 초기 컴파일
150
+ let result = await compiler.compileAsync();
151
+
152
+ // 파일 변경 감지 시 증분 컴파일
153
+ const changedFiles = new Set(["/workspace/packages/my-lib/src/foo.ts"]);
154
+ result = await compiler.compileAsync(changedFiles);
155
+
156
+ // SCSS 의존성이 변경된 TS 파일 찾기
157
+ const affectedByScss = compiler.findAffectedByScss("/workspace/packages/my-lib/scss/variables.scss");
158
+ ```
@@ -0,0 +1,74 @@
1
+ # @simplysm/service-client
2
+
3
+ > WebSocket 기반 서비스 서버 클라이언트. `@simplysm/service-server`(Fastify)에 연결하여 RPC 호출, 실시간 이벤트 구독/발행, 파일 업로드/다운로드, ORM 원격 실행을 수행한다. 브라우저와 Node.js 양쪽에서 동작하며, `ws` 패키지를 선택적 peer dependency로 사용한다.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @simplysm/service-client
9
+ ```
10
+
11
+ Node.js 환경에서 사용 시:
12
+
13
+ ```bash
14
+ npm install ws
15
+ ```
16
+
17
+ ## 하려는 작업 → 먼저 읽을 파일
18
+
19
+ | 작업 | 먼저 읽을 파일 |
20
+ |------|----------------|
21
+ | 서버 연결 및 RPC 호출 | [ServiceClient](./main/service-client.md) |
22
+ | 실시간 이벤트 구독/발행 | [EventClient](./features/event-client.md) |
23
+ | 파일 업로드/다운로드 | [FileClient](./features/file-client.md) |
24
+ | ORM 원격 트랜잭션 실행 | [OrmClientConnector](./features/orm-client-connector.md) |
25
+ | progress 모니터링 | [ServiceProgress](./types/service-progress.md) |
26
+ | 연결 옵션 설정 | [ServiceConnectionOptions](./types/service-connection-options.md) |
27
+
28
+ ## API Overview
29
+
30
+ ### Main
31
+
32
+ | Entry | Kind | 언제 쓰나 |
33
+ |-------|------|-----------|
34
+ | [`ServiceClient`](./main/service-client.md) | class | 서버에 연결하여 RPC, 이벤트, 파일, ORM 기능을 통합 사용할 때 |
35
+ | [`ServiceProxy<T>`](./main/service-client.md) | type | `getService<T>()`의 반환 타입으로, 서비스 메서드를 Promise로 래핑할 때 |
36
+ | [`createServiceClient()`](./main/service-client.md) | function | `new ServiceClient()` 대신 팩토리 함수로 인스턴스를 생성할 때 |
37
+
38
+ ### Transport
39
+
40
+ | Entry | Kind | 언제 쓰나 |
41
+ |-------|------|-----------|
42
+ | [`SocketProvider`](./transport/socket-provider.md) | interface | WebSocket 연결/재연결/하트비트를 직접 제어할 때 (일반적으로 `ServiceClient`가 내부 사용) |
43
+ | [`ServiceTransport`](./transport/service-transport.md) | interface | 요청-응답 매핑과 progress 중계를 직접 제어할 때 (일반적으로 `ServiceClient`가 내부 사용) |
44
+
45
+ ### Protocol
46
+
47
+ | Entry | Kind | 언제 쓰나 |
48
+ |-------|------|-----------|
49
+ | [`ClientProtocolWrapper`](./protocol/client-protocol-wrapper.md) | interface | 메시지 인코딩/디코딩을 직접 제어하거나 Worker 오프로드 동작을 이해할 때 (일반적으로 `ServiceClient`가 내부 사용) |
50
+
51
+ ### Features
52
+
53
+ | Entry | Kind | 언제 쓰나 |
54
+ |-------|------|-----------|
55
+ | [`EventClient`](./features/event-client.md) | interface | 서버 이벤트를 구독/발행할 때 (`ServiceClient.getEvent()` 경유 권장) |
56
+ | [`FileClient`](./features/file-client.md) | interface | 파일 업로드/다운로드를 직접 제어할 때 (`ServiceClient.uploadFile()`/`downloadFileBuffer()` 경유 권장) |
57
+ | [`OrmClientConnector`](./features/orm-client-connector.md) | interface | `DbContext` 트랜잭션을 원격 서버에서 실행할 때 |
58
+ | [`OrmClientDbContextExecutor`](./features/orm-client-db-context-executor.md) | class | `DbContextExecutor` 원격 구현체가 필요할 때 (`OrmClientConnector` 경유 권장) |
59
+
60
+ ### Types
61
+
62
+ | Entry | Kind | 언제 쓰나 |
63
+ |-------|------|-----------|
64
+ | [`ServiceConnectionOptions`](./types/service-connection-options.md) | interface | `ServiceClient` 생성자에 전달할 연결 옵션을 구성할 때 |
65
+ | [`ServiceProgress`](./types/service-progress.md) | interface | 요청/응답/서버 처리 progress를 모니터링할 때 |
66
+ | [`BlobInput`](./types/blob-input.md) | type | 파일 업로드 시 데이터 타입을 지정할 때 |
67
+ | [`FileCollection`](./types/file-collection.md) | interface | DOM `FileList` 호환 타입이 필요할 때 |
68
+ | [`BrowserWorker`](./types/browser-worker.md) | interface | Worker 인터페이스의 cross-env 타입 호환이 필요할 때 |
69
+
70
+ ## 이 패키지를 쓰지 말아야 할 때
71
+
72
+ - 서버 측 로직 구현 → [`@simplysm/service-server`](../service-server/README.md)
73
+ - 서버-클라이언트 공유 프로토콜/타입 정의 → [`@simplysm/service-common`](../service-common/README.md)
74
+ - ORM 스키마 정의나 쿼리빌더 → [`@simplysm/orm-common`](../orm-common/README.md)
@@ -0,0 +1,93 @@
1
+ # `EventClient`
2
+
3
+ 서버 이벤트 구독/발행 관리 인터페이스. 재연결 시 자동 재구독된다. 팩토리 함수 `createEventClient`로 생성한다.
4
+
5
+ ## When to use
6
+
7
+ - ✅ 서버에서 발행하는 실시간 이벤트를 구독하거나 다른 클라이언트에 이벤트를 발행할 때
8
+ - ❌ 일반적으로 `ServiceClient.getEvent()` / `ServiceClient.addListener()`를 통해 간접 사용한다. 직접 생성은 커스텀 전송 계층 구현 시에만 필요하다.
9
+
10
+ ```typescript
11
+ export interface EventClient {
12
+ getEvent<TEventDef extends ServiceEventDef>(
13
+ eventName: string,
14
+ ): ClientEventProxy<TEventDef>;
15
+ addListener<TEventDef extends ServiceEventDef>(
16
+ eventName: string,
17
+ info: TEventDef["$info"],
18
+ cb: (data: TEventDef["$data"]) => PromiseLike<void>,
19
+ ): Promise<string>;
20
+ removeListener(key: string): Promise<void>;
21
+ emit<TEventDef extends ServiceEventDef>(
22
+ eventName: string,
23
+ infoSelector: (item: TEventDef["$info"]) => boolean,
24
+ data: TEventDef["$data"],
25
+ ): Promise<void>;
26
+ resubscribeAll(): Promise<void>;
27
+ }
28
+ ```
29
+
30
+ ## Members
31
+
32
+ | Member | Kind | Type | Description |
33
+ |--------|------|------|-------------|
34
+ | `getEvent(eventName)` | method | `ClientEventProxy<TEventDef>` | 이벤트 이름과 타입을 캡처한 프록시 반환 |
35
+ | `addListener(eventName, info, cb)` | method | `Promise<string>` | 이벤트 리스너 등록. 반환값은 `key` (제거 시 사용) |
36
+ | `removeListener(key)` | method | `Promise<void>` | 등록된 이벤트 리스너 제거 |
37
+ | `emit(eventName, infoSelector, data)` | method | `Promise<void>` | `infoSelector`가 참인 대상에게 데이터 발행 |
38
+ | `resubscribeAll()` | method | `Promise<void>` | 재연결 시 모든 리스너를 서버에 재등록. `ServiceClient`가 자동 호출 |
39
+
40
+ ## Related Types
41
+
42
+ ### `ClientEventProxy`
43
+
44
+ `getEvent()`가 반환하는 이벤트 프록시 인터페이스. 이벤트 이름과 제네릭 타입이 캡처되어 있어 호출 시 반복 지정이 불필요하다.
45
+
46
+ ```typescript
47
+ export interface ClientEventProxy<TEventDef extends ServiceEventDef> {
48
+ addListener(
49
+ info: TEventDef["$info"],
50
+ cb: (data: TEventDef["$data"]) => PromiseLike<void>,
51
+ ): Promise<string>;
52
+ removeListener(key: string): Promise<void>;
53
+ emit(
54
+ infoSelector: (item: TEventDef["$info"]) => boolean,
55
+ data: TEventDef["$data"],
56
+ ): Promise<void>;
57
+ }
58
+ ```
59
+
60
+ | Member | Type | Description |
61
+ |--------|------|-------------|
62
+ | `addListener(info, cb)` | `Promise<string>` | 이벤트 리스너 등록. 반환값은 `key` (제거 시 사용) |
63
+ | `removeListener(key)` | `Promise<void>` | 등록된 이벤트 리스너 제거 |
64
+ | `emit(infoSelector, data)` | `Promise<void>` | `infoSelector`가 참인 대상에게 데이터 발행 |
65
+
66
+ ## `createEventClient`
67
+
68
+ `EventClient` 팩토리 함수.
69
+
70
+ ```typescript
71
+ export function createEventClient(transport: ServiceTransport): EventClient;
72
+ ```
73
+
74
+ | Parameter | Type | Description |
75
+ |-----------|------|-------------|
76
+ | `transport` | [`ServiceTransport`](../transport/service-transport.md) | 서비스 전송 계층 |
77
+
78
+ ## Usage
79
+
80
+ ```typescript
81
+ // getEvent() 방식 (권장 — 이벤트 이름과 타입이 캡처됨)
82
+ const chatEvt = client.getEvent<typeof ChatEvent>("Chat");
83
+ const key = await chatEvt.addListener({ roomId: "room-1" }, async (data) => {
84
+ console.log("메시지:", data.message);
85
+ });
86
+ await chatEvt.removeListener(key);
87
+
88
+ // 이벤트 발행
89
+ await chatEvt.emit(
90
+ (info) => info.roomId === "room-1",
91
+ { message: "hello" },
92
+ );
93
+ ```
@@ -0,0 +1,63 @@
1
+ # `FileClient`
2
+
3
+ 파일 업로드(POST `/upload`)/다운로드(GET) 인터페이스. 팩토리 함수 `createFileClient`로 생성한다.
4
+
5
+ ## When to use
6
+
7
+ - ✅ 서버에 파일을 업로드하거나 서버에서 파일을 다운로드할 때
8
+ - ❌ 일반적으로 `ServiceClient.uploadFile()` / `ServiceClient.downloadFileBuffer()`를 통해 간접 사용한다. 직접 생성은 인증 없이 다운로드만 수행하거나 커스텀 URL 구성이 필요할 때에만 사용한다.
9
+
10
+ ```typescript
11
+ export interface FileClient {
12
+ download(relPath: string): Promise<Bytes>;
13
+ upload(
14
+ files: File[] | FileCollection | { name: string; data: BlobInput }[],
15
+ authToken: string,
16
+ ): Promise<ServiceUploadResult[]>;
17
+ }
18
+ ```
19
+
20
+ ## Members
21
+
22
+ | Member | Kind | Type | Description |
23
+ |--------|------|------|-------------|
24
+ | `download(relPath)` | method | `Promise<Bytes>` | `GET {hostUrl}{relPath}`로 파일 다운로드. `Uint8Array` 반환 |
25
+ | `upload(files, authToken)` | method | `Promise<ServiceUploadResult[]>` | `POST {hostUrl}/upload`로 파일 업로드. `multipart/form-data` 사용 |
26
+
27
+ ### `upload` Parameters
28
+
29
+ | Parameter | Type | Description |
30
+ |-----------|------|-------------|
31
+ | `files` | `File[] \| FileCollection \| { name: string; data: BlobInput }[]` | 업로드할 파일 목록 |
32
+ | `authToken` | `string` | 인증 토큰 (`Authorization: Bearer {token}` 헤더로 전송) |
33
+
34
+ ## `createFileClient`
35
+
36
+ `FileClient` 팩토리 함수.
37
+
38
+ ```typescript
39
+ export function createFileClient(hostUrl: string, clientName: string): FileClient;
40
+ ```
41
+
42
+ | Parameter | Type | Description |
43
+ |-----------|------|-------------|
44
+ | `hostUrl` | `string` | 서버 기본 URL (`http://host:port` 형식) |
45
+ | `clientName` | `string` | 클라이언트 식별자 (`x-sd-client-name` 헤더로 전송) |
46
+
47
+ ## Usage
48
+
49
+ ```typescript
50
+ // 일반적으로 ServiceClient를 통해 간접 사용한다
51
+ // 파일 업로드 (auth() 호출 후 사용)
52
+ const results = await client.uploadFile([
53
+ new File(["content"], "file.txt", { type: "text/plain" }),
54
+ ]);
55
+
56
+ // 커스텀 데이터 업로드
57
+ const results2 = await client.uploadFile([
58
+ { name: "report.csv", data: "col1,col2\nval1,val2" },
59
+ ]);
60
+
61
+ // 파일 다운로드
62
+ const bytes = await client.downloadFileBuffer("/uploaded/file.txt");
63
+ ```
@@ -0,0 +1,89 @@
1
+ # `OrmClientConnector`
2
+
3
+ `DbContext` 트랜잭션 연결을 원격 서버에서 실행하는 헬퍼 인터페이스. 팩토리 함수 `createOrmClientConnector`로 생성한다.
4
+
5
+ ## When to use
6
+
7
+ - ✅ 클라이언트에서 `DbContext`를 통해 원격 DB 트랜잭션을 실행할 때
8
+ - ✅ FK 제약 위반 시 사용자 친화적 에러 메시지가 필요할 때 (`connect()` 메서드가 자동 변환)
9
+ - ❌ 서버 측에서 직접 DB에 접근할 때 → `@simplysm/orm-node` 사용
10
+
11
+ ```typescript
12
+ export interface OrmClientConnector {
13
+ connect<T extends DbContext, R>(
14
+ config: OrmConnectOptions<T>,
15
+ callback: (db: T) => Promise<R> | R,
16
+ ): Promise<R>;
17
+ connectWithoutTransaction<T extends DbContext, R>(
18
+ config: OrmConnectOptions<T>,
19
+ callback: (db: T) => Promise<R> | R,
20
+ ): Promise<R>;
21
+ }
22
+ ```
23
+
24
+ ## Members
25
+
26
+ | Member | Kind | Type | Description |
27
+ |--------|------|------|-------------|
28
+ | `connect(config, callback)` | method | `Promise<R>` | 트랜잭션 모드로 연결. FK 제약 위반 시 사용자 친화적 에러 메시지로 변환 |
29
+ | `connectWithoutTransaction(config, callback)` | method | `Promise<R>` | 트랜잭션 없이 연결 |
30
+
31
+ ## Related Types
32
+
33
+ ### `OrmConnectOptions`
34
+
35
+ ORM 원격 연결에 필요한 옵션 인터페이스.
36
+
37
+ ```typescript
38
+ export interface OrmConnectOptions<T extends DbContext> {
39
+ DbClass: new (executor: DbContextExecutor, opt: { database: string; schema?: string }) => T;
40
+ connOpt: DbConnOptions & { configName: string };
41
+ dbContextOpt?: {
42
+ database: string;
43
+ schema: string;
44
+ };
45
+ }
46
+ ```
47
+
48
+ | Field | Type | Required | Description |
49
+ |-------|------|----------|-------------|
50
+ | `DbClass` | `new (executor: DbContextExecutor, opt: { database: string; schema?: string }) => T` | required | 사용할 `DbContext` 서브클래스 생성자 |
51
+ | `connOpt` | `DbConnOptions & { configName: string }` | required | DB 연결 옵션. `configName`은 서버 설정 키 |
52
+ | `dbContextOpt` | `{ database: string; schema: string }` | optional | DB 컨텍스트 옵션. 생략하면 서버에서 조회한 `info.database`/`info.schema` 사용 |
53
+
54
+ ## `createOrmClientConnector`
55
+
56
+ `OrmClientConnector` 팩토리 함수.
57
+
58
+ ```typescript
59
+ export function createOrmClientConnector(serviceClient: ServiceClient): OrmClientConnector;
60
+ ```
61
+
62
+ | Parameter | Type | Description |
63
+ |-----------|------|-------------|
64
+ | `serviceClient` | [`ServiceClient`](../main/service-client.md) | 이미 연결된 서비스 클라이언트 |
65
+
66
+ ## Usage
67
+
68
+ ```typescript
69
+ import { createOrmClientConnector } from "@simplysm/service-client";
70
+
71
+ const connector = createOrmClientConnector(client);
72
+
73
+ // 트랜잭션 모드
74
+ const result = await connector.connect(
75
+ {
76
+ DbClass: MyDbContext,
77
+ connOpt: { configName: "main", username: "user", password: "pass" },
78
+ },
79
+ async (db) => {
80
+ return db.myTable.select((item) => ({ id: item.id, name: item.name }));
81
+ },
82
+ );
83
+
84
+ // 트랜잭션 없이
85
+ const result2 = await connector.connectWithoutTransaction(
86
+ { DbClass: MyDbContext, connOpt: { configName: "main" } },
87
+ async (db) => db.myTable.select(),
88
+ );
89
+ ```
@@ -0,0 +1,31 @@
1
+ # `OrmClientDbContextExecutor`
2
+
3
+ `DbContextExecutor` 인터페이스 구현체. `DbContext`의 쿼리 실행을 서버 `OrmService`에 원격 호출한다.
4
+
5
+ ## When to use
6
+
7
+ - ✅ `DbContext`에 주입할 원격 executor가 필요할 때 (커스텀 연결 로직 구현 시)
8
+ - ❌ 일반적으로 [`createOrmClientConnector`](./orm-client-connector.md)를 통해 간접 사용한다. 직접 사용은 트랜잭션 관리를 수동으로 제어해야 하는 특수한 경우에만 필요하다.
9
+
10
+ ```typescript
11
+ export class OrmClientDbContextExecutor implements DbContextExecutor {
12
+ constructor(
13
+ private readonly _client: ServiceClient,
14
+ private readonly _opt: DbConnOptions & { configName: string },
15
+ );
16
+ }
17
+ ```
18
+
19
+ ## Members
20
+
21
+ | Member | Kind | Type | Description |
22
+ |--------|------|------|-------------|
23
+ | `getInfo()` | method | `Promise<{ dialect: Dialect; database?: string; schema?: string }>` | 서버에서 DB dialect, database, schema 조회 |
24
+ | `connect()` | method | `Promise<void>` | 서버에서 DB 연결 생성. `_connId` 할당 |
25
+ | `beginTransaction(isolationLevel?)` | method | `Promise<void>` | 트랜잭션 시작 |
26
+ | `commitTransaction()` | method | `Promise<void>` | 트랜잭션 커밋 |
27
+ | `rollbackTransaction()` | method | `Promise<void>` | 트랜잭션 롤백 |
28
+ | `close()` | method | `Promise<void>` | DB 연결 종료 및 `_connId` 해제 |
29
+ | `executeDefs(defs, options?)` | method | `Promise<T[][]>` | QueryDef 배열을 서버에서 실행 |
30
+ | `executeParametrized(query, params?)` | method | `Promise<unknown[][]>` | 파라미터화된 쿼리를 서버에서 실행 |
31
+ | `bulkInsert(tableName, columnDefs, records)` | method | `Promise<void>` | 대량 INSERT를 서버에서 실행 |