@iglo.tech/iglo.base 1.0.1-rc.0 → 1.0.1

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.1
+
+- README: a pointer to the generated types (`iglo-base schema types`), for the types of your own collections. No code changes from 1.0.1-rc.0.
+
 ## 1.0.1-rc.0
 
 - Prerelease that validates npm trusted publishing from CI (OIDC, no token). No code changes from 1.0.0; published under the `next` tag.

package/README.md

@@ -301,6 +301,19 @@ If you want to manually cancel pending requests, you could use `pb.cancelAllRequ
 
 ### Specify TypeScript definitions
 
+For the types of your own collections, generate them from the schema with `schema types` (see [docs/schema.md](../docs/schema.md#types)). `pb.collection("posts")` is then typed as `PostsResponse`, and a collection name the schema does not have is a type error:
+
+```ts
+import PocketBase from "@iglo.tech/iglo.base";
+import type { TypedPocketBase } from "./iglo.types";
+
+const pb = new PocketBase("https://example.com") as TypedPocketBase;
+```
+
+The server and browser clients keep their methods when you pass their class: `createBrowserClient({ url }) as TypedPocketBase<BrowserClient>`.
+
+Without generated types, use the generics below.
+
 You could specify custom TypeScript definitions for your Record models using generics:
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iglo.tech/iglo.base",
-  "version": "1.0.1-rc.0",
+  "version": "1.0.1",
   "description": "JavaScript SDK for iglo.base (fork of the PocketBase JavaScript SDK v0.28.1)",
   "keywords": [
     "iglo.base",