1.3.0

README.md

@@ -101,6 +101,10 @@ await places.lists.getAll();
 
 // Get specific list
 await places.lists.get('to-do');
+
+// Get all places from a list
+await places.lists.getPlaces('to-do');
+```
 ```
 
 ## API Reference

dist/places.d.ts

@@ -192,6 +192,12 @@ export interface PlacesClient {
          * @param id - The slug ID of the list.
          */
         get(id: string): Promise<List | null>;
+        /**
+         * Get all places from a list.
+         * @param listId - The slug ID of the list.
+         * @returns Array of Place objects.
+         */
+        getPlaces(listId: string): Promise<Place[]>;
         /**
          * Create or update a list.
          * @param id - The slug ID (e.g., "to-go").

dist/places.js

@@ -103,6 +103,24 @@ const Places = function (privateClient /*, publicClient: BaseClient */) {
             const path = `_lists/${id}`;
             return privateClient.getObject(path);
         },
+        async getPlaces(listId) {
+            const list = await this.get(listId);
+            if (!list) {
+                throw new Error(`List not found: ${listId}`);
+            }
+            if (!list.placeRefs || !Array.isArray(list.placeRefs)) {
+                return [];
+            }
+            const promises = list.placeRefs.map(async (ref) => {
+                if (!ref.id || !ref.geohash)
+                    return null;
+                const path = getPath(ref.geohash, ref.id);
+                const place = await privateClient.getObject(path);
+                return place;
+            });
+            const results = await Promise.all(promises);
+            return results.filter((p) => !!p);
+        },
         async create(id, title, color) {
             const path = `_lists/${id}`;
             let list = (await privateClient.getObject(path));

docs/interfaces/PlacesClient.md

@@ -120,6 +120,26 @@ Get all lists.
 
 Array of List objects.
 
+#### getPlaces()
+
+> **getPlaces**(`listId`): `Promise`\<[`Place`](../type-aliases/Place.md)[]\>
+
+Get all places from a list.
+
+##### Parameters
+
+###### listId
+
+`string`
+
+The slug ID of the list.
+
+##### Returns
+
+`Promise`\<[`Place`](../type-aliases/Place.md)[]\>
+
+Array of Place objects.
+
 #### removePlace()
 
 > **removePlace**(`listId`, `placeId`): `Promise`\<[`List`](../type-aliases/List.md)\>

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@remotestorage/module-places",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@remotestorage/module-places",
-      "version": "1.2.2",
+      "version": "1.3.0",
       "license": "MIT",
       "dependencies": {
         "latlon-geohash": "^2.0.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotestorage/module-places",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "description": "Manage favorite/saved places",
   "homepage": "https://gitea.kosmos.org/raucao/remotestorage-module-places#remotestoragemodule-places",
   "repository": {

src/places.ts

@@ -154,6 +154,13 @@ export interface PlacesClient {
      */
     get(id: string): Promise<List | null>;
 
+    /**
+     * Get all places from a list.
+     * @param listId - The slug ID of the list.
+     * @returns Array of Place objects.
+     */
+    getPlaces(listId: string): Promise<Place[]>;
+
     /**
      * Create or update a list.
      * @param id - The slug ID (e.g., "to-go").
@@ -249,6 +256,27 @@ const Places = function (
       return privateClient.getObject(path) as Promise<List | null>;
     },
 
+    async getPlaces(listId: string): Promise<Place[]> {
+      const list = await this.get(listId);
+      if (!list) {
+        throw new Error(`List not found: ${listId}`);
+      }
+
+      if (!list.placeRefs || !Array.isArray(list.placeRefs)) {
+        return [];
+      }
+
+      const promises = list.placeRefs.map(async (ref: any) => {
+        if (!ref.id || !ref.geohash) return null;
+        const path = getPath(ref.geohash, ref.id);
+        const place = await privateClient.getObject(path);
+        return place as Place | null;
+      });
+
+      const results = await Promise.all(promises);
+      return results.filter((p): p is Place => !!p);
+    },
+
     async create(id: string, title: string, color?: string): Promise<List> {
       const path = `_lists/${id}`;
       let list = (await privateClient.getObject(path)) as List;

test/places.test.ts

@@ -203,6 +203,64 @@ describe('Places Module', () => {
       });
     });
 
+    describe('getPlaces', () => {
+      it('returns all places from a list', async () => {
+        const mockList = {
+          id: 'hiking',
+          title: 'Hiking',
+          placeRefs: [
+            { id: 'place-1', geohash: 'u33dc0' },
+            { id: 'place-2', geohash: 'w1q789' },
+          ],
+        };
+
+        const mockPlace1 = { id: 'place-1', geohash: 'u33dc0', title: 'Hiking Trail' };
+        const mockPlace2 = { id: 'place-2', geohash: 'w1q789', title: 'Mountain Peak' };
+
+        mockClient.getObject.mockImplementation(async (path: string) => {
+          if (path === '_lists/hiking') return mockList;
+          if (path === 'u3/3d/place-1') return mockPlace1;
+          if (path === 'w1/q7/place-2') return mockPlace2;
+          return null;
+        });
+
+        const result = await lists.getPlaces('hiking');
+        expect(mockClient.getObject).toHaveBeenCalledWith('_lists/hiking');
+        expect(mockClient.getObject).toHaveBeenCalledWith('u3/3d/place-1');
+        expect(mockClient.getObject).toHaveBeenCalledWith('w1/q7/place-2');
+        expect(result).toEqual([mockPlace1, mockPlace2]);
+      });
+
+      it('throws an error if the list does not exist', async () => {
+        mockClient.getObject.mockResolvedValue(null);
+
+        await expect(lists.getPlaces('non-existent')).rejects.toThrow('List not found: non-existent');
+        expect(mockClient.getObject).toHaveBeenCalledWith('_lists/non-existent');
+      });
+
+      it('filters out any places that failed to load or are missing', async () => {
+        const mockList = {
+          id: 'hiking',
+          title: 'Hiking',
+          placeRefs: [
+            { id: 'place-1', geohash: 'u33dc0' },
+            { id: 'place-2', geohash: 'w1q789' },
+          ],
+        };
+
+        const mockPlace1 = { id: 'place-1', geohash: 'u33dc0', title: 'Place 1' };
+
+        mockClient.getObject.mockImplementation(async (path: string) => {
+          if (path === '_lists/hiking') return mockList;
+          if (path === 'u3/3d/place-1') return mockPlace1;
+          return null; // place-2 is missing
+        });
+
+        const result = await lists.getPlaces('hiking');
+        expect(result).toEqual([mockPlace1]);
+      });
+    });
+
     describe('create', () => {
       it('stores a new list when none exists', async () => {
         const now = '2023-01-01T00:00:00.000Z';