@medusajs/types 2.8.3 → 2.8.4-snapshot-20250522142303

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.
@@ -111,28 +111,28 @@ export interface IFileModuleService extends IModuleService {
111
111
  */
112
112
  retrieveFile(id: string, config?: FindConfig<FileDTO>, sharedContext?: Context): Promise<FileDTO>;
113
113
  /**
114
- * This method is used to retrieve a file by ID, similarly to `retrieve`. It doesn't retrieve multiple files, but it's added to support retrieving files with [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query).
114
+ * This method is used to list files. It only supports filtering by ID.
115
115
  *
116
116
  * @param {FilterableFileProps} filters - The filters to apply on the retrieved files.
117
117
  * @param {FindConfig<FileDTO>} config -
118
118
  * The configurations determining how the files are retrieved. Its properties, such as `select` or `relations`, accept the
119
119
  * attributes or relations associated with a file.
120
120
  * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
121
- * @returns {Promise<FileDTO[]>} The list of files. In this case, it will have at most one file.
121
+ * @returns {Promise<FileDTO[]>} The list of files.
122
122
  *
123
123
  * @example
124
- * const files = await fileModuleService.listFiles({ id: "file_123" })
124
+ * const files = await fileModuleService.listFiles({ id: ["file_123", "file_456"] })
125
125
  */
126
126
  listFiles(filters?: FilterableFileProps, config?: FindConfig<FileDTO>, sharedContext?: Context): Promise<FileDTO[]>;
127
127
  /**
128
- * This method is used to retrieve a file by ID, similarly to `retrieve`. It doesn't retrieve multiple files, but it's added to support retrieving files with [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query).
128
+ * This method is used to list files and their count. It only supports filtering by ID.
129
129
  *
130
130
  * @param {FilterableFileProps} filters - The filters to apply on the retrieved files.
131
131
  * @param {FindConfig<FileDTO>} config -
132
132
  * The configurations determining how the files are retrieved. Its properties, such as `select` or `relations`, accept the
133
133
  * attributes or relations associated with a file.
134
134
  * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
135
- * @returns {Promise<[FileDTO[], number]>} The list of files and their count. In this case, it will have at most one file.
135
+ * @returns {Promise<[FileDTO[], number]>} The list of files and their count.
136
136
  *
137
137
  * @example
138
138
  * const [files] = await fileModuleService.listAndCountFiles({ id: "file_123" })
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@medusajs/types",
3
- "version": "2.8.3",
3
+ "version": "2.8.4-snapshot-20250522142303",
4
4
  "description": "Medusa Types definition",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",