@seaverse/data-service-sdk 0.7.0 → 0.9.0
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.
- package/README.md +52 -34
- package/dist/browser.js +8 -8
- package/dist/browser.js.map +1 -1
- package/dist/browser.umd.js +8 -8
- package/dist/browser.umd.js.map +1 -1
- package/dist/index.cjs +8 -8
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +4 -4
- package/dist/index.js +8 -8
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/browser.umd.js
CHANGED
|
@@ -4204,7 +4204,7 @@
|
|
|
4204
4204
|
* ```typescript
|
|
4205
4205
|
* // Read system announcements
|
|
4206
4206
|
* const path = getPublicReadPath('my-app', 'announcements');
|
|
4207
|
-
* // Returns: 'appData/my-app/publicRead/announcements'
|
|
4207
|
+
* // Returns: 'appData/my-app/publicRead/_data/announcements'
|
|
4208
4208
|
*
|
|
4209
4209
|
* const snapshot = await getDocs(collection(db, path));
|
|
4210
4210
|
* ```
|
|
@@ -4212,7 +4212,7 @@
|
|
|
4212
4212
|
function getPublicReadPath(appId, collectionName) {
|
|
4213
4213
|
validateSegment('appId', appId);
|
|
4214
4214
|
validateSegment('collectionName', collectionName);
|
|
4215
|
-
return `appData/${appId}/publicRead/${collectionName}`;
|
|
4215
|
+
return `appData/${appId}/publicRead/_data/${collectionName}`;
|
|
4216
4216
|
}
|
|
4217
4217
|
/**
|
|
4218
4218
|
* Generate path for publicData (read/write for all authenticated users)
|
|
@@ -4225,7 +4225,7 @@
|
|
|
4225
4225
|
* ```typescript
|
|
4226
4226
|
* // Write a public post
|
|
4227
4227
|
* const path = getPublicDataPath('my-app', 'posts');
|
|
4228
|
-
* // Returns: 'appData/my-app/publicData/posts'
|
|
4228
|
+
* // Returns: 'appData/my-app/publicData/_data/posts'
|
|
4229
4229
|
*
|
|
4230
4230
|
* await addDoc(collection(db, path), {
|
|
4231
4231
|
* _appId: appId,
|
|
@@ -4238,7 +4238,7 @@
|
|
|
4238
4238
|
function getPublicDataPath(appId, collectionName) {
|
|
4239
4239
|
validateSegment('appId', appId);
|
|
4240
4240
|
validateSegment('collectionName', collectionName);
|
|
4241
|
-
return `appData/${appId}/publicData/${collectionName}`;
|
|
4241
|
+
return `appData/${appId}/publicData/_data/${collectionName}`;
|
|
4242
4242
|
}
|
|
4243
4243
|
/**
|
|
4244
4244
|
* Generate path for userData (private, read/write only by owner)
|
|
@@ -4279,7 +4279,7 @@
|
|
|
4279
4279
|
* @example
|
|
4280
4280
|
* ```typescript
|
|
4281
4281
|
* const path = getPublicReadDocPath('my-app', 'announcements', 'announcement-1');
|
|
4282
|
-
* // Returns: 'appData/my-app/publicRead/announcements/announcement-1'
|
|
4282
|
+
* // Returns: 'appData/my-app/publicRead/_data/announcements/announcement-1'
|
|
4283
4283
|
*
|
|
4284
4284
|
* const docSnap = await getDoc(doc(db, path));
|
|
4285
4285
|
* ```
|
|
@@ -4288,7 +4288,7 @@
|
|
|
4288
4288
|
validateSegment('appId', appId);
|
|
4289
4289
|
validateSegment('collectionName', collectionName);
|
|
4290
4290
|
validateSegment('docId', docId);
|
|
4291
|
-
return `appData/${appId}/publicRead/${collectionName}/${docId}`;
|
|
4291
|
+
return `appData/${appId}/publicRead/_data/${collectionName}/${docId}`;
|
|
4292
4292
|
}
|
|
4293
4293
|
/**
|
|
4294
4294
|
* Generate path for a specific document in publicData
|
|
@@ -4301,7 +4301,7 @@
|
|
|
4301
4301
|
* @example
|
|
4302
4302
|
* ```typescript
|
|
4303
4303
|
* const path = getPublicDataDocPath('my-app', 'posts', 'post-123');
|
|
4304
|
-
* // Returns: 'appData/my-app/publicData/posts/post-123'
|
|
4304
|
+
* // Returns: 'appData/my-app/publicData/_data/posts/post-123'
|
|
4305
4305
|
*
|
|
4306
4306
|
* const docSnap = await getDoc(doc(db, path));
|
|
4307
4307
|
* ```
|
|
@@ -4310,7 +4310,7 @@
|
|
|
4310
4310
|
validateSegment('appId', appId);
|
|
4311
4311
|
validateSegment('collectionName', collectionName);
|
|
4312
4312
|
validateSegment('docId', docId);
|
|
4313
|
-
return `appData/${appId}/publicData/${collectionName}/${docId}`;
|
|
4313
|
+
return `appData/${appId}/publicData/_data/${collectionName}/${docId}`;
|
|
4314
4314
|
}
|
|
4315
4315
|
/**
|
|
4316
4316
|
* Generate path for a specific document in userData
|