@pristy/pristy-libvue 1.14.4 → 1.15.0

package/README.md

@@ -1,35 +1,100 @@
 # Pristy Libvue
 
-Code factoring for Pristy
+Shared Vue 3 component library for the [Pristy](https://pristy.fr/) ECM suite. Provides reusable components, services, stores, composables, and plugins used across all Pristy frontend applications.
 
-## Developing with Pristy-libvue
+## Installation
 
-Add `@pristy/pristy-libvue` package.
+```bash
+npm install @pristy/pristy-libvue
+```
+
+## Usage
 
-Then call the available classes where necessary. Be careful, there is no default class, you must use {} in the import.
+All exports use named imports:
 
-```vue
-import { AlfrescoFileService } from "@pristy/pristy-libvue"
+```js
+import { alfrescoFileService, useUserStore, TreeExplorer } from "@pristy/pristy-libvue"
 ```
 
-## Dev locally
+### What's included
+
+| Category | Examples | Count |
+|---|---|---|
+| **Components** | `TreeExplorer`, `PDFComponent`, `DynamicContentView`, `CopyOrMovePopup`, `AdvancedSearchPanel`, `ChatPanel` | ~45 |
+| **Services** | `alfrescoFileService`, `alfrescoNodeService`, `configService`, `workspaceService`, `errorService` | ~20 |
+| **Stores** (Pinia) | `useUserStore`, `useConfigStore`, `useNavigationStore`, `useFavoritesStore`, `useSearchStore` | ~15 |
+| **Composables** | `useCodeMirror`, `useMarkdownPreview`, `useCollabEditor`, `useCollabWebSocket` | 5 |
+| **Pages** | `LoginPage`, `NotFoundPages`, `ErrorPage` | 3 |
+| **Plugins** | `vueKeyCloak` | 1 |
+
+See [`src/index.js`](src/index.js) for the full list of exports.
+
+## Peer Dependencies
+
+These must be installed by the consuming application:
 
-1. In prity-libvue
+| Package | Version |
+|---|---|
+| `vue` | ^3.5 |
+| `vue-i18n` | ^11.3 |
+| `vue-router` | ^4.6 |
+| `@codemirror/*` | ^6.x (14 packages) |
+| `codemirror` | 6.0.2 |
 
+## Local Development
+
+### Build the library
+
+```bash
+npm install
+npm run build:library
 ```
+
+### Link locally to another Pristy app
+
+```bash
+# In pristy-libvue
 npm link
+
+# In the consuming app (e.g. pristy-espaces)
+npm link ../pristy-libvue
+npm run dev.link      # Uses vite.config.link.js
 ```
 
-2. In another pristy application
+After any change to pristy-libvue, rebuild with `npm run build:library` (or use `npm run build:dev` for watch mode with source maps).
 
-```
-npm link <local directory off pristy-libvue>
-```
+### Available scripts
 
-The library needs to be built by vite to be usable locally.
+| Script | Description |
+|---|---|
+| `npm run build:library` | Production build (ESM + UMD + CSS + .d.ts) |
+| `npm run build:dev` | Watch mode build with source maps |
+| `npm run analyze` | Bundle size analysis (opens stats.html) |
+| `npm run lint` | Lint and auto-fix with ESLint |
+| `npm run check` | Lint without fixing (CI mode) |
+| `npm run format` | Format with Prettier |
+| `npm run test` | Run tests with Vitest |
+| `npm run coverage` | Generate test coverage report |
 
-```
-npm run build:library
-```
+## Architecture
+
+The library follows a **Services → Stores → Components** pattern:
+
+- **Services** (`src/services/`): Stateless modules handling API calls and business logic
+- **Stores** (`src/stores/`): Pinia stores managing session state
+- **Components** (`src/components/`): UI presentation consuming stores
+- **Composables** (`src/composables/`): Reusable composition functions (CodeMirror, Markdown, WebSocket)
+
+## Conventions
+
+- **Icons**: Remixicon only (`ri-*` classes). No PrimeIcons.
+- **i18n**: All user-facing strings must use `$t('key')`. No hardcoded text.
+- **Imports**: Use `@/` alias for all internal imports. Never import from `@/index.js` internally.
+- **License**: Every `.vue` and `.js` file must include the AGPL-3.0 header.
+- **Comments**: English only.
+
+See the root [`CLAUDE.md`](../CLAUDE.md) for the full convention reference.
+
+## License
 
-The pristy-libvue package of the package.json will be overloaded by the local library.
+[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html) - Copyright (C) 2022 [Jeci SARL](https://jeci.fr)

package/dist/components/navigation/PreviewPanel.vue.d.ts

@@ -167,8 +167,8 @@ declare const _default: DefineComponent<ExtractPropTypes<{
     }>> & Readonly<{
         onReload?: (...args: any[]) => any;
     }>, {
-        canUpload: boolean;
         versionId: string;
+        canUpload: boolean;
         showTitle: boolean;
         showButtons: boolean;
     }, {}, {

package/dist/components/search/AdvancedSearchPanel.vue.d.ts

@@ -1,4 +1,5 @@
 import { DefineComponent, ComponentOptionsMixin, PublicProps, ExtractPropTypes, ComponentProvideOptions } from 'vue';
+import { SavedView, ViewLocation, ViewCriterion } from '../../stores/userView.js';
 import { ResultSetPaging } from '@alfresco/js-api';
 import { default as __DTS_DEFAULT_0__ } from 'primevue/togglebutton';
 import { default as __DTS_DEFAULT_1__ } from 'primevue/dropdown';

package/dist/components/search/AdvancedSearchPanel.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AdvancedSearchPanel.vue.d.ts","sourceRoot":"","sources":["../../../src/components/search/AdvancedSearchPanel.vue"],"names":[],"mappings":";;;;;;;;;;;;AAiNA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAodA,KAlX+C,CAkX/C,aAjXC;;;;;;;;;;;6BAiXD,MAtOM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAsON,KAlO2B;;2BAkO3B,KAhMG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAgMH,KAlX+C,CAkX/C,aAjXC;;;;;;;;;;;iCAiXD,MAtOM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBA2OgB,oBAAoB;yBACjB,uBAAuB;yBAEvB,uBAAuB;sBAC1B,oBAAoB;mBACvB,iBAAiB;mBAGjB,iBAAiB"}
+{"version":3,"file":"AdvancedSearchPanel.vue.d.ts","sourceRoot":"","sources":["../../../src/components/search/AdvancedSearchPanel.vue"],"names":[],"mappings":";;;;;;;;;;;;;AAiNA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAsdA,KApX+C,CAoX/C,aAnXC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAmXD,KApOa;;2BAoOb,KAlMqD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAkMrD,KApX+C,CAoX/C,aAnXC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBA0XqB,oBAAoB;yBACjB,uBAAuB;yBAEvB,uBAAuB;sBAC1B,oBAAoB;mBACvB,iBAAiB;mBAGjB,iBAAiB"}

package/dist/components/search/AdvancedViewPanel.vue.d.ts

@@ -1,4 +1,5 @@
 import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions, ExtractPropTypes } from 'vue';
+import { SavedView, ViewLocation, ViewCriterion } from '../../stores/userView.js';
 import { default as __DTS_DEFAULT_0__ } from 'primevue/dropdown';
 import { default as __DTS_DEFAULT_1__ } from 'primevue/calendar';
 import { default as __DTS_DEFAULT_2__ } from 'primevue/inputnumber';

package/dist/components/search/AdvancedViewPanel.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AdvancedViewPanel.vue.d.ts","sourceRoot":"","sources":["../../../src/components/search/AdvancedViewPanel.vue"],"names":[],"mappings":";;;;;;;;;;AA6SA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAylBA,KAjfqC,CAifrC,aAhfY;;;;;;;;;;;6BAgfZ,MAlXU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAkXV,KAjfqC,CAifrC,aAhfY;;;;;;;;;;;iCAgfZ,MAlXU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAuXY,oBAAoB;yBACjB,uBAAuB;yBAEvB,uBAAuB;sBAC1B,oBAAoB;yBACjB,uBAAuB;mBAC7B,iBAAiB;mBAGjB,iBAAiB"}
+{"version":3,"file":"AdvancedViewPanel.vue.d.ts","sourceRoot":"","sources":["../../../src/components/search/AdvancedViewPanel.vue"],"names":[],"mappings":";;;;;;;;;;;AA6SA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0BA2lBA,KAnfqC,CAmfrC,aAlfY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAkfZ,KAnfqC,CAmfrC,aAlfY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAyfU,oBAAoB;yBACjB,uBAAuB;yBAEvB,uBAAuB;sBAC1B,oBAAoB;yBACjB,uBAAuB;mBAC7B,iBAAiB;mBAGjB,iBAAiB"}

package/dist/components/search/FavoriteViewMenu.vue.d.ts

@@ -1,4 +1,5 @@
 import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { SavedView, ViewLocation, ViewCriterion } from '../../stores/userView.js';
 declare const _default: DefineComponent<{}, {}, {}, {
     [x: string]: () => never;
 }, {

package/dist/components/search/FavoriteViewMenu.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FavoriteViewMenu.vue.d.ts","sourceRoot":"","sources":["../../../src/components/search/FavoriteViewMenu.vue"],"names":[],"mappings":";AA6CA;;;;IA4GI;;;OAGG"}
+{"version":3,"file":"FavoriteViewMenu.vue.d.ts","sourceRoot":"","sources":["../../../src/components/search/FavoriteViewMenu.vue"],"names":[],"mappings":";;AA6CA;;;;IA4GI;;;OAGG"}

package/dist/components/search/SaveViewPopup.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SaveViewPopup.vue.d.ts","sourceRoot":"","sources":["../../../src/components/search/SaveViewPopup.vue"],"names":[],"mappings":";AA2FA;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAmMA,KAtEiB,CAsEjB,aArEI;;;;;;;;;;;6BA6KyB,MACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAvGe,iBAAiB;sBACd,oBAAoB;qBACrB,mBAAmB;yBACf,uBAAuB;mBAC7B,iBAAiB"}
+{"version":3,"file":"SaveViewPopup.vue.d.ts","sourceRoot":"","sources":["../../../src/components/search/SaveViewPopup.vue"],"names":[],"mappings":";AA2FA;;;;;;;;;;;;;;;;;;;;;;;;;;;0BAmMA,KAtEc,CAsEd,aArEC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAuEkB,iBAAiB;sBACd,oBAAoB;qBACrB,mBAAmB;yBACf,uBAAuB;mBAC7B,iBAAiB"}

package/dist/components/search/UserViewsFavoritesPanel.vue.d.ts

@@ -1,4 +1,5 @@
 import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+import { SavedView, ViewLocation, ViewCriterion } from '../../stores/userView.js';
 import { default as Dropdown } from 'primevue/dropdown';
 declare const _default: DefineComponent<{}, {}, {
     selectedPersonalSearch: any;

package/dist/components/search/UserViewsFavoritesPanel.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserViewsFavoritesPanel.vue.d.ts","sourceRoot":"","sources":["../../../src/components/search/UserViewsFavoritesPanel.vue"],"names":[],"mappings":";AAuGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAqKqB,mBAAmB"}
+{"version":3,"file":"UserViewsFavoritesPanel.vue.d.ts","sourceRoot":"","sources":["../../../src/components/search/UserViewsFavoritesPanel.vue"],"names":[],"mappings":";;AAuGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAqKqB,mBAAmB"}

package/dist/components/viewer/ImageViewer.vue.d.ts

@@ -68,8 +68,8 @@ declare const _default: DefineComponent<ExtractPropTypes<{
 }>> & Readonly<{
     onReload?: (...args: any[]) => any;
 }>, {
-    canUpload: boolean;
     versionId: string;
+    canUpload: boolean;
     showTitle: boolean;
     showButtons: boolean;
 }, {}, {

package/dist/composables/useCollabEditor.d.ts

@@ -7,5 +7,11 @@
 export function useCollabEditor(): any;
 export const ROLE_EDITOR: "editor";
 export const ROLE_OBSERVER: "observer";
+/**
+ * Protocol version supported by this client.
+ * Must match or exceed the server's MIN_CLIENT_PROTOCOL_VERSION.
+ * Increment when adding breaking protocol changes (new required message types, etc.).
+ */
+export const PROTOCOL_VERSION: 2;
 export default useCollabEditor;
 //# sourceMappingURL=useCollabEditor.d.ts.map

package/dist/composables/useCollabEditor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCollabEditor.d.ts","sourceRoot":"","sources":["../../src/composables/useCollabEditor.js"],"names":[],"mappings":"AA0JA;;;;;GAKG;AACH,uCAk3BC;AAz+BD,0BAA2B,QAAQ,CAAC;AACpC,4BAA6B,UAAU,CAAC"}
+{"version":3,"file":"useCollabEditor.d.ts","sourceRoot":"","sources":["../../src/composables/useCollabEditor.js"],"names":[],"mappings":"AAiKA;;;;;GAKG;AACH,uCAw5BC;AAthCD,0BAA2B,QAAQ,CAAC;AACpC,4BAA6B,UAAU,CAAC;AAExC;;;;GAIG;AACH,+BAAgC,CAAC,CAAC"}

package/dist/composables/useCollabWebSocket.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCollabWebSocket.d.ts","sourceRoot":"","sources":["../../src/composables/useCollabWebSocket.js"],"names":[],"mappings":"AA0CA;;;;;;GAMG;AACH,sDAuSC"}
+{"version":3,"file":"useCollabWebSocket.d.ts","sourceRoot":"","sources":["../../src/composables/useCollabWebSocket.js"],"names":[],"mappings":"AA0CA;;;;;;GAMG;AACH,sDAySC"}