@outbuild/supa-store 0.1.0 → 1.0.0

package/README.md

@@ -1,24 +1,66 @@
-# ObSupaStore
+# Supastore
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.0.
+A helper library for including angular auth in your Angular app.
 
-## Code scaffolding
+## Basic usage, provide in main.ts
 
-Run `ng generate component component-name --project ob-supa-store` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project ob-supa-store`.
-> Note: Don't forget to add `--project ob-supa-store` or else it will be added to the default project in your `angular.json` file. 
+This will provide the supabase client and the auth object for logged user as signals.
 
-## Build
+```typescript
+import { provideSupaStore } from '@outbuild/supa-store'
 
-Run `ng build ob-supa-store` to build the project. The build artifacts will be stored in the `dist/` directory.
+provideSupaStore({
+  createClient:{
+    supabaseUrl: environment.supabaseUrl,
+    supabaseKey: environment.supabaseKey
+  }
+})
+```
 
-## Publishing
+## Including Metadata in the user object
 
-After building your library with `ng build ob-supa-store`, go to the dist folder `cd dist/ob-supa-store` and run `npm publish`.
+In many cases users will have metadata that you want to include in the user object. You can do this by providing the 'metadataTable' option. This will automatically fetch the metadata from the table matching the user the 'id' field and include it in the auth object. in most cases this will be the 'users' table.
 
-## Running unit tests
+There are also instances where you would want to run a custom rpc function to return a auth object, lets imagine custom logic for user, organisation data etc. you can do this by providing the 'metadataRpc' option.
 
-Run `ng test ob-supa-store` to execute the unit tests via [Karma](https://karma-runner.github.io).
+This will run immediatelty after the user is authenticated, either table option, or rpc option not both.
 
-## Further help
+```typescript
+import { provideSupaStore } from '@outbuild/supa-store'
+
+provideSupaStore({
+  createClient:{
+    supabaseUrl: environment.supabaseUrl,
+    supabaseKey: environment.supabaseKey
+  },
+  metadataTable: 'users' 
+  metadataRpc: 'auth_query'
+})
+```
+
+## Accessing the store
+
+```typescript
+  import { injectSupaAuth, injectSupaClient } from '@outbuild/supa-store'
+
+  auth   = injectSupaAuth()
+  client = injectSupaClient()
+```
+
+## Store type
+
+```typescript
+type SupaStoreState = {
+  client: SupabaseClient                  // Supabase Client
+  auth: {
+    session: Session | undefined | null   // Supabase Session
+    user: User | undefined | null         // Supabase User
+    metadata: unknown | undefined | null  // Your metadat if provided
+    state: {      
+      prev: AuthChangeEvent | null,       // Supabase Auth Change Event
+      curr: AuthChangeEvent | null,       // Supabase Auth Change Event
+    }
+  }
+}
+```
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outbuild/supa-store",
-  "version": "0.1.00",
+  "version": "1.0.0",
   "peerDependencies": {
     "@angular/common": "^19.2.0",
     "@angular/core": "^19.2.0",