cozy-sharing 37.4.0 → 37.5.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [37.5.0](https://github.com/cozy/cozy-libs/compare/cozy-sharing@37.4.0...cozy-sharing@37.5.0) (2026-08-25)
+
+### Features
+
+- **cozy-sharing:** Export recipient types ([ca5fd55](https://github.com/cozy/cozy-libs/commit/ca5fd554471320993cd89eaca33a65a09d2ecc46))
+
 # [37.4.0](https://github.com/cozy/cozy-libs/compare/cozy-sharing@37.3.0...cozy-sharing@37.4.0) (2026-08-25)
 
 ### Features

package/README.md

@@ -82,6 +82,17 @@ const MyComp = () => {
 }
 ```
 
+### Recipient types
+
+`SharingMember` and `SharingGroup` model the values returned by the stack.
+`cozy-sharing` adds display metadata and returns `SharingMemberRecipient` or
+`SharingGroupRecipient` from its recipient selectors. TypeScript consumers can
+use their union when both are possible:
+
+```ts
+import type { SharingRecipient } from 'cozy-sharing/types'
+```
+
 ***
 
 ## How it works

package/dist/state.js

@@ -430,10 +430,14 @@ export var getOwner = function getOwner(state, docId) {
     return r.status === 'owner';
   });
 };
+/** @returns {import('../types').SharingRecipient[]} */
+
 export var getRecipients = function getRecipients(state, docId) {
   var sharings = getDocumentSharings(state, docId);
   return getRecipientsFromSharings(sharings, docId);
 };
+/** @returns {import('../types').SharingRecipient[]} */
+
 export var getRecipientsFromSharing = function getRecipientsFromSharing(sharing, docId) {
   if (!sharing) {
     return [];
@@ -466,6 +470,8 @@ var getRecipientType = function getRecipientType(sharing, member, documentType)
 
   return documentType;
 };
+/** @returns {import('../types').SharingMemberRecipient[]} */
+
 
 var getRecipientsWithoutGroups = function getRecipientsWithoutGroups(sharings, docId) {
   var recipients = sharings.map(function (sharing) {
@@ -493,6 +499,8 @@ var getRecipientsWithoutGroups = function getRecipientsWithoutGroups(sharings, d
 
   return recipients;
 };
+/** @returns {import('../types').SharingRecipient[]} */
+
 
 export var getRecipientsWithGroups = function getRecipientsWithGroups(sharings, docId) {
   var recipients = sharings.flatMap(function (sharing) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-sharing",
-  "version": "37.4.0",
+  "version": "37.5.0",
   "description": "Provides sharing login for React applications.",
   "main": "dist/index.js",
   "author": "Cozy",
@@ -59,7 +59,7 @@
     "cozy-intent": "^2.31.1",
     "cozy-minilog": "^3.10.1",
     "cozy-ui": "^140.5.0",
-    "cozy-ui-plus": "^12.3.8",
+    "cozy-ui-plus": "^12.3.9",
     "jest": "30.3.0",
     "jest-environment-jsdom": "30.3.0",
     "react": "16.12.0",
@@ -85,5 +85,5 @@
   "sideEffects": [
     "*.css"
   ],
-  "gitHead": "b20d8f7573c3d64dddc40ec8baa69037423fa368"
+  "gitHead": "814149b46bd8ddbc22384fd5dda8a14dc41ee806"
 }

package/src/state.js

@@ -341,11 +341,13 @@ export const canReshare = (state, docId, instanceUri) => {
 export const getOwner = (state, docId) =>
   getRecipients(state, docId).find(r => r.status === 'owner')
 
+/** @returns {import('../types').SharingRecipient[]} */
 export const getRecipients = (state, docId) => {
   const sharings = getDocumentSharings(state, docId)
   return getRecipientsFromSharings(sharings, docId)
 }
 
+/** @returns {import('../types').SharingRecipient[]} */
 export const getRecipientsFromSharing = (sharing, docId) => {
   if (!sharing) {
     return []
@@ -379,6 +381,7 @@ const getRecipientType = (sharing, member, documentType) => {
   return documentType
 }
 
+/** @returns {import('../types').SharingMemberRecipient[]} */
 const getRecipientsWithoutGroups = (sharings, docId) => {
   const recipients = sharings
     .map(sharing => {
@@ -400,6 +403,7 @@ const getRecipientsWithoutGroups = (sharings, docId) => {
   return recipients
 }
 
+/** @returns {import('../types').SharingRecipient[]} */
 export const getRecipientsWithGroups = (sharings, docId) => {
   const recipients = sharings.flatMap(sharing => {
     const type = getDocumentSharingType(sharing, docId)

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "cozy-tsconfig",
+  "include": ["types.d.ts"]
+}

package/types.d.ts

@@ -0,0 +1,46 @@
+/** Member fields returned by the stack sharing API. */
+export interface SharingMember {
+  email?: string
+  groups?: number[]
+  instance?: string
+  name?: string
+  only_in_groups?: boolean
+  public_name?: string
+  read_only?: boolean
+  status: string
+}
+
+/** Group fields returned by the stack sharing API. */
+export interface SharingGroup {
+  addedBy: number
+  color?: string
+  id?: string
+  name: string
+  read_only: boolean
+  revoked?: boolean
+}
+
+/** Member enriched by cozy-sharing for display. */
+export type SharingMemberRecipient = SharingMember & {
+  avatarPath: string
+  /** Stable display identifier generated by cozy-sharing. */
+  index: string
+  /** Position in the members array returned by the stack. */
+  memberIndex: number
+  sharingId: string
+  type: 'one-way' | 'two-way'
+}
+
+/** Group enriched by cozy-sharing for display. */
+export type SharingGroupRecipient = SharingGroup & {
+  /** Position in the groups array returned by the stack. */
+  groupIndex: number
+  /** Stable display identifier generated by cozy-sharing. */
+  index: string
+  members: SharingMemberRecipient[]
+  owner: SharingMemberRecipient
+  sharingId: string
+}
+
+/** Member or group returned by cozy-sharing recipient selectors. */
+export type SharingRecipient = SharingMemberRecipient | SharingGroupRecipient