Skip to content

feat: Update get full path to use in shared drive ✨ #1630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 24, 2025
Merged

feat: Update get full path to use in shared drive ✨ #1630

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/api/cozy-client/interfaces/models.file.FileUploadOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Conflict options

*Defined in*

[packages/cozy-client/src/models/file.js:548](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L548)
[packages/cozy-client/src/models/file.js:553](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L553)

***

Expand All @@ -26,7 +26,7 @@ Erase / rename

*Defined in*

[packages/cozy-client/src/models/file.js:547](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L547)
[packages/cozy-client/src/models/file.js:552](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L552)

***

Expand All @@ -38,7 +38,7 @@ The file Content-Type

*Defined in*

[packages/cozy-client/src/models/file.js:546](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L546)
[packages/cozy-client/src/models/file.js:551](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L551)

***

Expand All @@ -50,7 +50,7 @@ The dirId to upload the file to

*Defined in*

[packages/cozy-client/src/models/file.js:544](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L544)
[packages/cozy-client/src/models/file.js:549](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L549)

***

Expand All @@ -62,7 +62,7 @@ ID of the shared drive in which the file should be saved

*Defined in*

[packages/cozy-client/src/models/file.js:549](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L549)
[packages/cozy-client/src/models/file.js:554](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L554)

***

Expand All @@ -74,7 +74,7 @@ An object containing the metadata to attach

*Defined in*

[packages/cozy-client/src/models/file.js:545](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L545)
[packages/cozy-client/src/models/file.js:550](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L550)

***

Expand All @@ -86,4 +86,4 @@ The file name to upload

*Defined in*

[packages/cozy-client/src/models/file.js:543](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L543)
[packages/cozy-client/src/models/file.js:548](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L548)
37 changes: 19 additions & 18 deletions docs/api/cozy-client/modules/models.file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Copies a file to a specified destination.

*Defined in*

[packages/cozy-client/src/models/file.js:666](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L666)
[packages/cozy-client/src/models/file.js:671](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L671)

***

Expand Down Expand Up @@ -78,7 +78,7 @@ that will process the download

*Defined in*

[packages/cozy-client/src/models/file.js:721](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L721)
[packages/cozy-client/src/models/file.js:726](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L726)

***

Expand Down Expand Up @@ -126,7 +126,7 @@ file object with path attribute

*Defined in*

[packages/cozy-client/src/models/file.js:647](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L647)
[packages/cozy-client/src/models/file.js:652](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L652)

***

Expand Down Expand Up @@ -175,7 +175,7 @@ Generate a file name for a revision

*Defined in*

[packages/cozy-client/src/models/file.js:533](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L533)
[packages/cozy-client/src/models/file.js:538](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L538)

***

Expand All @@ -200,7 +200,7 @@ A filename with the right suffix

*Defined in*

[packages/cozy-client/src/models/file.js:503](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L503)
[packages/cozy-client/src/models/file.js:508](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L508)

***

Expand Down Expand Up @@ -228,17 +228,18 @@ Returns folder encryption reference

### getFullpath

▸ **getFullpath**(`client`, `dirId`, `name`): `Promise`<`string`>
▸ **getFullpath**(`client`, `dirId`, `name`, `driveId?`): `Promise`<`string`>

async getFullpath - Gets a file's path

*Parameters*

| Name | Type | Description |
| :------ | :------ | :------ |
| `client` | [`CozyClient`](../classes/CozyClient.md) | The CozyClient instance |
| `dirId` | `string` | The id of the parent directory |
| `name` | `string` | The file's name |
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `client` | [`CozyClient`](../classes/CozyClient.md) | `undefined` | The CozyClient instance |
| `dirId` | `string` | `undefined` | The id of the parent directory |
| `name` | `string` | `undefined` | The file's name |
| `driveId` | `any` | `undefined` | - |

*Returns*

Expand Down Expand Up @@ -364,7 +365,7 @@ The mime-type of the target file, or an empty string is the target is not a file

*Defined in*

[packages/cozy-client/src/models/file.js:625](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L625)
[packages/cozy-client/src/models/file.js:630](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L630)

***

Expand Down Expand Up @@ -408,7 +409,7 @@ Whether the file's metadata attribute exists

*Defined in*

[packages/cozy-client/src/models/file.js:617](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L617)
[packages/cozy-client/src/models/file.js:622](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L622)

***

Expand Down Expand Up @@ -556,7 +557,7 @@ Whether the folder is client-side encrypted

*Defined in*

[packages/cozy-client/src/models/file.js:636](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L636)
[packages/cozy-client/src/models/file.js:641](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L641)

***

Expand Down Expand Up @@ -621,7 +622,7 @@ Whether the file is supported by Only Office

*Defined in*

[packages/cozy-client/src/models/file.js:609](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L609)
[packages/cozy-client/src/models/file.js:614](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L614)

***

Expand Down Expand Up @@ -771,7 +772,7 @@ Manage 4 cases :

*Defined in*

[packages/cozy-client/src/models/file.js:371](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L371)
[packages/cozy-client/src/models/file.js:376](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L376)

***

Expand Down Expand Up @@ -826,7 +827,7 @@ The overrided file

*Defined in*

[packages/cozy-client/src/models/file.js:463](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L463)
[packages/cozy-client/src/models/file.js:468](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L468)

***

Expand Down Expand Up @@ -938,4 +939,4 @@ If there is a conflict, then we apply the conflict strategy : `erase` or `rename

*Defined in*

[packages/cozy-client/src/models/file.js:567](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L567)
[packages/cozy-client/src/models/file.js:572](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/models/file.js#L572)
13 changes: 9 additions & 4 deletions packages/cozy-client/src/models/file.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,14 +338,19 @@ export const hasMetadataAttribute = ({ file, attribute }) =>
* @param {string} name - The file's name
* @returns {Promise<string>} The full path of the file in the cozy
**/
export const getFullpath = async (client, dirId, name) => {
export const getFullpath = async (client, dirId, name, driveId = undefined) => {
if (!dirId) {
throw new Error('You must provide a dirId')
}

const { data: parentDir } = await client.query(
Q(DOCTYPE_FILES).getById(dirId)
)
let query = Q(DOCTYPE_FILES).getById(dirId)

if (driveId) {
query = query.sharingById(driveId)
}

const { data: parentDir } = await client.query(query)

const parentDirectoryPath = trimEnd(parentDir.path, '/')
return `${parentDirectoryPath}/${name}`
}
Expand Down
2 changes: 1 addition & 1 deletion packages/cozy-client/types/models/file.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export function hasMetadataAttribute({ file, attribute }: {
file: import("../types").IOCozyFile;
attribute: string;
}): boolean;
export function getFullpath(client: CozyClient, dirId: string, name: string): Promise<string>;
export function getFullpath(client: CozyClient, dirId: string, name: string, driveId?: any): Promise<string>;
export function move(client: CozyClient, file: import('../types').IOCozyFile | import('../types').NextcloudFile, destination: import('../types').IOCozyFolder | import('../types').NextcloudFile, { force, driveId }?: {
force: boolean;
driveId: string;
Expand Down
Loading