supabase-typed-query 0.9.1 → 0.9.3
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/dist/src/types.d.ts +19 -5
- package/dist/src/types.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/src/types.d.ts
CHANGED
|
@@ -24,11 +24,24 @@ export interface SchemaDefinition {
|
|
|
24
24
|
* Base schema interface that all databases must conform to.
|
|
25
25
|
* Consumer-provided Database types must extend this interface.
|
|
26
26
|
* Supports multiple schemas (public, custom schemas, etc.)
|
|
27
|
+
*
|
|
28
|
+
* Note: Uses permissive index signature to accept Supabase's __InternalSupabase metadata.
|
|
29
|
+
* Use CleanDatabase<DB> or Omit<DB, '__InternalSupabase'> when strict typing is needed.
|
|
27
30
|
*/
|
|
28
31
|
export interface DatabaseSchema {
|
|
29
32
|
public: SchemaDefinition;
|
|
30
33
|
[schemaName: string]: SchemaDefinition;
|
|
31
34
|
}
|
|
35
|
+
/**
|
|
36
|
+
* Helper type to strip `__InternalSupabase` from Supabase-generated database types.
|
|
37
|
+
* Following Supabase's own pattern from SupabaseClient.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```typescript
|
|
41
|
+
* type Schemas = keyof TypedDatabase<Database> // "public" | "inventory" (excludes __InternalSupabase)
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
export type TypedDatabase<DB> = Omit<DB, "__InternalSupabase">;
|
|
32
45
|
/**
|
|
33
46
|
* Default Database type - used as fallback when no specific database type is provided.
|
|
34
47
|
* For proper type inference, consumers should pass their generated Database type as a generic.
|
|
@@ -53,9 +66,10 @@ export interface Database extends DatabaseSchema {
|
|
|
53
66
|
}
|
|
54
67
|
/**
|
|
55
68
|
* Schema names for a given database.
|
|
69
|
+
* Uses Omit pattern (same as Supabase's SupabaseClient) to exclude __InternalSupabase.
|
|
56
70
|
* @typeParam DB - The database schema type (defaults to placeholder Database)
|
|
57
71
|
*/
|
|
58
|
-
export type SchemaNames<DB extends DatabaseSchema = Database> = keyof DB & string;
|
|
72
|
+
export type SchemaNames<DB extends DatabaseSchema = Database> = keyof TypedDatabase<DB> & string;
|
|
59
73
|
/**
|
|
60
74
|
* Default schema name constant.
|
|
61
75
|
*/
|
|
@@ -65,28 +79,28 @@ export declare const DEFAULT_SCHEMA: "public";
|
|
|
65
79
|
* @typeParam DB - The database schema type (defaults to placeholder Database)
|
|
66
80
|
* @typeParam S - The schema name (defaults to "public")
|
|
67
81
|
*/
|
|
68
|
-
export type TableNames<DB extends DatabaseSchema = Database, S extends SchemaNames<DB> = "public"
|
|
82
|
+
export type TableNames<DB extends DatabaseSchema = Database, S extends SchemaNames<DB> = "public" & SchemaNames<DB>> = keyof DB[S]["Tables"] & string;
|
|
69
83
|
/**
|
|
70
84
|
* Row type for a given table in a database schema.
|
|
71
85
|
* @typeParam T - The table name
|
|
72
86
|
* @typeParam DB - The database schema type (defaults to placeholder Database)
|
|
73
87
|
* @typeParam S - The schema name (defaults to "public")
|
|
74
88
|
*/
|
|
75
|
-
export type TableRow<T extends TableNames<DB, S>, DB extends DatabaseSchema = Database, S extends SchemaNames<DB> = "public"
|
|
89
|
+
export type TableRow<T extends TableNames<DB, S>, DB extends DatabaseSchema = Database, S extends SchemaNames<DB> = "public" & SchemaNames<DB>> = DB[S]["Tables"][T]["Row"];
|
|
76
90
|
/**
|
|
77
91
|
* Insert type for a given table in a database schema.
|
|
78
92
|
* @typeParam T - The table name
|
|
79
93
|
* @typeParam DB - The database schema type (defaults to placeholder Database)
|
|
80
94
|
* @typeParam S - The schema name (defaults to "public")
|
|
81
95
|
*/
|
|
82
|
-
export type TableInsert<T extends TableNames<DB, S>, DB extends DatabaseSchema = Database, S extends SchemaNames<DB> = "public"
|
|
96
|
+
export type TableInsert<T extends TableNames<DB, S>, DB extends DatabaseSchema = Database, S extends SchemaNames<DB> = "public" & SchemaNames<DB>> = DB[S]["Tables"][T]["Insert"];
|
|
83
97
|
/**
|
|
84
98
|
* Update type for a given table in a database schema.
|
|
85
99
|
* @typeParam T - The table name
|
|
86
100
|
* @typeParam DB - The database schema type (defaults to placeholder Database)
|
|
87
101
|
* @typeParam S - The schema name (defaults to "public")
|
|
88
102
|
*/
|
|
89
|
-
export type TableUpdate<T extends TableNames<DB, S>, DB extends DatabaseSchema = Database, S extends SchemaNames<DB> = "public"
|
|
103
|
+
export type TableUpdate<T extends TableNames<DB, S>, DB extends DatabaseSchema = Database, S extends SchemaNames<DB> = "public" & SchemaNames<DB>> = DB[S]["Tables"][T]["Update"];
|
|
90
104
|
export type EmptyObject = Record<string, never>;
|
|
91
105
|
export interface QueryBuilder extends Promise<{
|
|
92
106
|
data: unknown;
|
package/dist/src/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CACZ,MAAM,EACN;QACE,GAAG,EAAE,MAAM,CAAA;QACX,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,MAAM,CAAA;KACf,CACF,CAAA;IACD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAA;IAC9D,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACzC;AAED
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CACZ,MAAM,EACN;QACE,GAAG,EAAE,MAAM,CAAA;QACX,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,MAAM,CAAA;KACf,CACF,CAAA;IACD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAA;IAC9D,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACzC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,gBAAgB,CAAA;IACxB,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAAA;CACvC;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,EAAE,oBAAoB,CAAC,CAAA;AAE9D;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,cAAc;IAC9C,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CACZ,MAAM,EACN;YACE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;YAC5B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;YAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAChC,CACF,CAAA;QACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE,CAAC,CAAA;QACvD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAAC,OAAO,EAAE,OAAO,CAAA;SAAE,CAAC,CAAA;QAC9E,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC9B,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACxC,CAAA;CACF;AAMD;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,EAAE,SAAS,cAAc,GAAG,QAAQ,IAAI,MAAM,aAAa,CAAC,EAAE,CAAC,GAAG,MAAM,CAAA;AAEhG;;GAEG;AACH,eAAO,MAAM,cAAc,EAAG,QAAiB,CAAA;AAE/C;;;;GAIG;AACH,MAAM,MAAM,UAAU,CACpB,EAAE,SAAS,cAAc,GAAG,QAAQ,EACpC,CAAC,SAAS,WAAW,CAAC,EAAE,CAAC,GAAG,QAAQ,GAAG,WAAW,CAAC,EAAE,CAAC,IACpD,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAA;AAElC;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAClB,CAAC,SAAS,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,EAC3B,EAAE,SAAS,cAAc,GAAG,QAAQ,EACpC,CAAC,SAAS,WAAW,CAAC,EAAE,CAAC,GAAG,QAAQ,GAAG,WAAW,CAAC,EAAE,CAAC,IACpD,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,EAC3B,EAAE,SAAS,cAAc,GAAG,QAAQ,EACpC,CAAC,SAAS,WAAW,CAAC,EAAE,CAAC,GAAG,QAAQ,GAAG,WAAW,CAAC,EAAE,CAAC,IACpD,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;AAEhC;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,EAC3B,EAAE,SAAS,cAAc,GAAG,QAAQ,EACpC,CAAC,SAAS,WAAW,CAAC,EAAE,CAAC,GAAG,QAAQ,GAAG,WAAW,CAAC,EAAE,CAAC,IACpD,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;AAOhC,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAO/C,MAAM,WAAW,YAAa,SAAQ,OAAO,CAAC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;IAC9E,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,YAAY,CAAA;IAC1C,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,YAAY,CAAA;IACvC,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,YAAY,CAAA;IACvC,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,YAAY,CAAA;IAC1E,MAAM,EAAE,MAAM,YAAY,CAAA;IAC1B,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,YAAY,CAAA;IACvD,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,YAAY,CAAA;IACpD,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,YAAY,CAAA;IACrD,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,YAAY,CAAA;IACpD,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,YAAY,CAAA;IACrD,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,YAAY,CAAA;IACpD,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,YAAY,CAAA;IACrD,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,YAAY,CAAA;IACvD,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,YAAY,CAAA;IACxD,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,KAAK,YAAY,CAAA;IAC3D,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,YAAY,CAAA;IACvD,EAAE,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,YAAY,CAAA;IACrC,MAAM,EAAE,MAAM,YAAY,CAAA;IAC1B,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,YAAY,CAAA;IACtC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE,KAAK,YAAY,CAAA;CAC3E;AAMD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,OAAO,CAAA;IACrC,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAClC,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,CAAA;IAClC,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAA;IACrE,MAAM,EAAE,MAAM,OAAO,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,oBAAoB,CAAA;CAC9C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB,CAAC,EAAE,SAAS,cAAc,GAAG,QAAQ;IACtE,IAAI,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC,KAAK,OAAO,CAAA;IACxC,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,sBAAsB,CAAA;CACjD"}
|