surreal-zod 0.0.0-alpha.1 → 0.0.0-alpha.10

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import * as sz from "./zod/schema";
+export { sz };
+export default sz;

package/lib/index.js

@@ -1,3 +1,3 @@
-import * as sz from "./zod";
+import * as sz from "./zod/schema";
 export { sz };
 export default sz;

package/lib/print.d.ts

@@ -0,0 +1,2 @@
+import type * as z4 from "zod/v4/core";
+export declare function zodToSexpr(schema: z4.$ZodType): string;

package/lib/surql.d.ts

@@ -0,0 +1,77 @@
+import { BoundQuery, Table } from "surrealdb";
+import * as z4 from "zod/v4/core";
+import type { SurrealZodTable, SurrealZodTableNormal, SurrealZodTableRelation, SurrealZodType } from "./zod/schema";
+export type ZodTypeName = z4.$ZodType["_zod"]["def"]["type"];
+export type SurrealZodTypeName = SurrealZodType["_zod"]["def"]["type"];
+export declare function tableToSurql(table: SurrealZodTable, statement: "define", defineOptions?: DefineTableOptions): BoundQuery<[undefined]>;
+export declare function tableToSurql(table: SurrealZodTable, statement: "remove", removeOptions?: RemoveTableOptions): BoundQuery<[undefined]>;
+export declare function tableToSurql(table: SurrealZodTable, statement: "info"): BoundQuery<[TableInfo]>;
+export declare function tableToSurql(table: SurrealZodTable, statement: "structure"): BoundQuery<[TableStructure]>;
+export type RemoveTableOptions = {
+    /**
+     * What to do if the table is missing.
+     * - "ignore": Ignore the error and continue.
+     * - "error": Throw an error if the table is missing.
+     * @default "error"
+     */
+    missing?: "ignore" | "error";
+};
+export declare function removeTable(table: SurrealZodTable, options?: RemoveTableOptions): BoundQuery<[undefined]>;
+export interface TableInfo {
+    events: Record<string, string>;
+    fields: Record<string, string>;
+    indexes: Record<string, string>;
+    lives: Record<string, string>;
+    tables: Record<string, string>;
+}
+export declare function infoTable(table: SurrealZodTable): BoundQuery<[TableInfo]>;
+export interface TableStructure {
+    events: unknown[];
+    fields: FieldStructure[];
+    indexes: unknown[];
+    lives: unknown[];
+    tables: unknown[];
+}
+export interface FieldStructure {
+    name: string;
+    kind: string;
+    permissions: {
+        create: boolean;
+        select: boolean;
+        update: boolean;
+    };
+    readonly: boolean;
+    what: string;
+}
+export declare function structureTable(table: SurrealZodTable): BoundQuery<[TableStructure]>;
+export type DefineTableOptions = {
+    exists?: "ignore" | "error" | "overwrite";
+    fields?: boolean;
+};
+export declare function defineTable(schema: SurrealZodTable, options?: DefineTableOptions): BoundQuery<[undefined, ...undefined[]]>;
+export declare function isNormalTable(table: SurrealZodTable): table is SurrealZodTableNormal;
+export declare function isRelationTable(table: SurrealZodTable): table is SurrealZodTableRelation;
+export interface ZodToSurqlOptions<S extends z4.$ZodObject> {
+    table: string | Table;
+    schemafull?: boolean;
+    exists?: "ignore" | "error" | "overwrite";
+    drop?: boolean;
+    comment?: string;
+    schema: S;
+}
+export type DefineFieldOptions = {
+    exists?: "ignore" | "error" | "overwrite";
+    schemafull?: boolean;
+};
+type ZodSurrealTypeContext = {
+    type: Set<string>;
+    depth: number;
+    children: ZodSurrealChildType[];
+    flexible: boolean;
+};
+type ZodSurrealChildType = {
+    name: string;
+    type: z4.$ZodType;
+};
+export declare function inferSurrealType(type: SurrealZodType, context: ZodSurrealTypeContext): string;
+export {};