@zuzjs/flare 0.2.13 → 0.2.15

package/README.md

@@ -545,6 +545,38 @@ service cloud.firestore {
 
 Tip: if you set owner uid at create time, prefer checking `requestData.uid` on create and `resourceData.uid` on update/delete.
 
+## Internal Collection Aliases
+
+The client can use public collection names for server-managed collections.
+The server maps these names to internal `_flare_*` collections automatically for reads, writes, queries, subscriptions, and rules-related lookups.
+
+Prefer the public names in SDK code:
+
+| Public name | Internal collection |
+| --- | --- |
+| `users` | `_flare_auth_users` |
+| `sessions` | `_flare_auth_sessions` |
+| `auth_fields` | `_flare_auth_fields` |
+| `email_links` | `_flare_email_links` |
+| `email_outbox` | `_flare_email_outbox` |
+| `email_verifications` | `_flare_email_verifications` |
+| `password_recoveries` | `_flare_password_recoveries` |
+| `push_tokens` | `_flare_push_tokens` |
+| `push_outbox` | `_flare_push_outbox` |
+| `index_suggestions` | `_flare_index_suggestions` |
+
+Example:
+
+```ts
+const app = connectApp({ endpoint: 'https://flare.zuzcdn.net', appId: 'my-app', apiKey: 'ak' });
+
+const me = await app.collection('users').doc('alice').get();
+const activeSessions = await app.collection('sessions').where({ uid: 'alice' }).get();
+const pushTokens = await app.collection('push_tokens').where({ uid: 'alice' }).get();
+
+console.log(me.data(), activeSessions.docs.length, pushTokens.docs.length);
+```
+
 Emails are sent only through app-level templates stored in `_flare_email_templates`.
 
 Template placeholders use `{key}` syntax and are replaced from `values`.