@stoker-platform/types 0.5.30 → 0.5.32

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@stoker-platform/types",
-    "version": "0.5.30",
+    "version": "0.5.32",
     "type": "module",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "src/main.ts",

package/src/types/app.ts

@@ -178,12 +178,14 @@ export interface AdminConfig {
     homePage?: Record<StokerRole, StokerCollection> | (() => Record<StokerRole, StokerCollection>)
 }
 
-export type GenerateGlobalConfig = (
-    sdk: "web" | "node",
-    config?: WebUtilities | NodeUtilities,
+export interface GenerateGlobalConfigParams {
+    sdk: "web" | "node"
+    utils?: WebUtilities | NodeUtilities
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    context?: any,
-) => GlobalConfig
+    context?: any
+}
+
+export type GenerateGlobalConfig = (params: GenerateGlobalConfigParams) => GlobalConfig
 
 export type Region =
     | "asia-east1"

package/src/types/schema.ts

@@ -225,7 +225,7 @@ export interface CollectionAccess {
 export type PreOperationHookArgs = {
     operation: "read" | "create" | "update" | "delete"
     data?: StokerRecord
-    docId?: string
+    recordId?: string
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     context?: any
     batch?: WriteBatch
@@ -242,7 +242,7 @@ export type PostReadHookArgs = {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     context: any
     refs: unknown[]
-    doc?: StokerRecord
+    record?: StokerRecord
     listener?: boolean
 }
 export type PreDuplicateHookArgs = { data: Partial<StokerRecord> }
@@ -257,7 +257,7 @@ export type PreValidateHookArgs = {
 export type PreWriteHookArgs = {
     operation: "create" | "update" | "delete"
     data: StokerRecord
-    docId: string
+    recordId: string
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     context: any
     batch?: WriteBatch
@@ -266,7 +266,7 @@ export type PreWriteHookArgs = {
 export type PostWriteHookArgs = {
     operation: "create" | "update" | "delete"
     data: StokerRecord
-    docId: string
+    recordId: string
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     context: any
     retry?: boolean
@@ -275,7 +275,7 @@ export type PostWriteHookArgs = {
 export type PostWriteErrorHookArgs = {
     operation: "create" | "update" | "delete"
     data: StokerRecord
-    docId: string
+    recordId: string
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     context: any
     error: unknown
@@ -287,7 +287,7 @@ export type PostWriteErrorHookArgs = {
 export type PostOperationHookArgs = {
     operation: "read" | "create" | "update" | "delete"
     data?: StokerRecord
-    docId?: string
+    recordId?: string
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     context?: any
     retry?: boolean
@@ -466,8 +466,8 @@ export interface CollectionCustomCache {
     disableOfflineDelete?: boolean
 }
 
-// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface ListConfig {
+    roles?: StokerRole[]
     title?: string
 }
 
@@ -940,6 +940,8 @@ export interface StandardField {
     required?: boolean
     nullable?: boolean
 
+    addToAuthToken?: boolean
+
     access?: StokerRole[]
     restrictCreate?: StokerRole[] | boolean
     restrictUpdate?: StokerRole[] | boolean
@@ -1119,12 +1121,13 @@ export interface CollectionsSchema {
     version: number
 }
 
-export type GenerateSchema = (
-    sdk: "web" | "node",
-    config?: WebUtilities | NodeUtilities,
+export interface GenerateSchemaParams {
+    sdk: "web" | "node"
+    utils?: WebUtilities | NodeUtilities
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    context?: any,
-) => CollectionSchema
+    context?: any
+}
+export type GenerateSchema = (params: GenerateSchemaParams) => CollectionSchema
 
 export interface RoleGroup {
     key: string