@tailor-platform/sdk 1.16.0 → 1.17.0

package/dist/{index-Ds8lbSJb.d.mts → types-BeNtD-fA.d.mts}

@@ -1,5 +1,5 @@
 /// <reference path="./user-defined.d.ts" />
-import { Et as TailorDBServiceInput, c as BuiltinIdP, pt as ResolverServiceInput, r as AuthConfig } from "./types-_sYDzqHG.mjs";
+import { Et as TailorDBServiceInput, c as BuiltinIdP, pt as ResolverServiceInput, r as AuthConfig } from "./types-DzvazVmg.mjs";
 import { z } from "zod";
 
 //#region src/parser/service/executor/schema.d.ts
@@ -170,6 +170,68 @@ type ExecutorServiceConfig = {
 };
 type ExecutorServiceInput = ExecutorServiceConfig;
 //#endregion
+//#region src/parser/service/workflow/types.d.ts
+type WorkflowServiceConfig = {
+  files: string[];
+  job_files?: string[];
+  ignores?: string[];
+  job_ignores?: string[];
+};
+type WorkflowServiceInput = WorkflowServiceConfig;
+//#endregion
+//#region src/parser/generator-config/types.d.ts
+type GeneratorConfig = z.input<typeof BaseGeneratorConfigSchema>;
+type CodeGeneratorBase = Omit<z.output<typeof CodeGeneratorSchema>, "dependencies"> & {
+  dependencies: readonly DependencyKind[];
+};
+//#endregion
+//#region src/parser/generator-config/index.d.ts
+declare const DependencyKindSchema: z.ZodEnum<{
+  executor: "executor";
+  tailordb: "tailordb";
+  resolver: "resolver";
+}>;
+type DependencyKind = z.infer<typeof DependencyKindSchema>;
+declare const CodeGeneratorSchema: z.ZodObject<{
+  id: z.ZodString;
+  description: z.ZodString;
+  dependencies: z.ZodArray<z.ZodEnum<{
+    executor: "executor";
+    tailordb: "tailordb";
+    resolver: "resolver";
+  }>>;
+  processType: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  processResolver: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  processExecutor: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  processTailorDBNamespace: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  processResolverNamespace: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  aggregate: z.ZodFunction<z.core.$ZodFunctionArgs, z.ZodAny>;
+}, z.core.$strip>;
+declare const BaseGeneratorConfigSchema: z.ZodUnion<readonly [z.ZodTuple<[z.ZodLiteral<"@tailor-platform/kysely-type">, z.ZodObject<{
+  distPath: z.ZodString;
+}, z.core.$strip>], null>, z.ZodTuple<[z.ZodLiteral<"@tailor-platform/seed">, z.ZodObject<{
+  distPath: z.ZodString;
+  machineUserName: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>], null>, z.ZodTuple<[z.ZodLiteral<"@tailor-platform/enum-constants">, z.ZodObject<{
+  distPath: z.ZodString;
+}, z.core.$strip>], null>, z.ZodTuple<[z.ZodLiteral<"@tailor-platform/file-utils">, z.ZodObject<{
+  distPath: z.ZodString;
+}, z.core.$strip>], null>, z.ZodObject<{
+  id: z.ZodString;
+  description: z.ZodString;
+  dependencies: z.ZodArray<z.ZodEnum<{
+    executor: "executor";
+    tailordb: "tailordb";
+    resolver: "resolver";
+  }>>;
+  processType: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  processResolver: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  processExecutor: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  processTailorDBNamespace: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  processResolverNamespace: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
+  aggregate: z.ZodFunction<z.core.$ZodFunctionArgs, z.ZodAny>;
+}, z.core.$strip>]>;
+//#endregion
 //#region src/parser/service/staticwebsite/schema.d.ts
 declare const StaticWebsiteSchema: z.core.$ZodBranded<z.ZodObject<{
   name: z.ZodString;
@@ -199,15 +261,6 @@ declare function defineStaticWebSite(name: string, config: Omit<StaticWebsiteInp
 } & StaticWebsiteDefinitionBrand;
 type StaticWebsiteConfig = Omit<ReturnType<typeof defineStaticWebSite>, "url">;
 //#endregion
-//#region src/parser/service/workflow/types.d.ts
-type WorkflowServiceConfig = {
-  files: string[];
-  job_files?: string[];
-  ignores?: string[];
-  job_ignores?: string[];
-};
-type WorkflowServiceInput = WorkflowServiceConfig;
-//#endregion
 //#region src/parser/service/idp/schema.d.ts
 declare const IdPSchema: z.core.$ZodBranded<z.ZodObject<{
   name: z.ZodString;
@@ -274,123 +327,43 @@ type IdPOwnConfig = Omit<DefinedIdp<string, IdPInput, string>, "provider">;
 type IdPConfig = IdPOwnConfig | IdPExternalConfig;
 //#endregion
 //#region src/parser/app-config/types.d.ts
+/**
+ * Application configuration for `defineConfig()`.
+ *
+ * Key fields:
+ * - `name` (required): Application name
+ * - `cors`: Array of allowed origins, e.g. `["https://example.com"]`
+ * - `auth`: Single auth config object (not an array)
+ * - `idp`: Array of IdP configs, e.g. `[myIdp]`
+ * - `staticWebsites`: Array of static website configs, e.g. `[website]`
+ * - `db`, `resolver`, `executor`, `workflow`: Service configs with file globs
+ */
 interface AppConfig<Auth extends AuthConfig = AuthConfig, Idp extends IdPConfig[] = IdPConfig[], StaticWebsites extends StaticWebsiteConfig[] = StaticWebsiteConfig[], Env extends Record<string, string | number | boolean> = Record<string, string | number | boolean>> {
+  /** Application name (required). */
   name: string;
+  /** Environment variables accessible via `context.env` in resolvers and via the second argument `{ env }` in workflow job bodies. */
   env?: Env;
+  /** Allowed CORS origins. Must be an array of strings, e.g. `["https://example.com"]`. */
   cors?: string[];
+  /** IP addresses allowed to access the application. */
   allowedIpAddresses?: string[];
+  /** Disable GraphQL introspection in production. */
   disableIntrospection?: boolean;
+  /** TailorDB service configuration with type definition files. */
   db?: TailorDBServiceInput;
+  /** Resolver service configuration with resolver files. */
   resolver?: ResolverServiceInput;
+  /** Identity Provider configurations. Must be an array, e.g. `[myIdp]`. */
   idp?: Idp;
+  /** Auth configuration (single object, not an array). */
   auth?: Auth;
+  /** Executor service configuration with executor files. */
   executor?: ExecutorServiceInput;
+  /** Workflow service configuration with workflow files. */
   workflow?: WorkflowServiceInput;
+  /** Static website configurations. Must be an array, e.g. `[website]`. */
   staticWebsites?: StaticWebsites;
 }
 //#endregion
-//#region src/parser/generator-config/types.d.ts
-type GeneratorConfig = z.input<typeof BaseGeneratorConfigSchema>;
-type CodeGeneratorBase = Omit<z.output<typeof CodeGeneratorSchema>, "dependencies"> & {
-  dependencies: readonly DependencyKind[];
-};
-//#endregion
-//#region src/parser/generator-config/index.d.ts
-declare const DependencyKindSchema: z.ZodEnum<{
-  executor: "executor";
-  tailordb: "tailordb";
-  resolver: "resolver";
-}>;
-type DependencyKind = z.infer<typeof DependencyKindSchema>;
-declare const CodeGeneratorSchema: z.ZodObject<{
-  id: z.ZodString;
-  description: z.ZodString;
-  dependencies: z.ZodArray<z.ZodEnum<{
-    executor: "executor";
-    tailordb: "tailordb";
-    resolver: "resolver";
-  }>>;
-  processType: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processResolver: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processExecutor: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processTailorDBNamespace: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processResolverNamespace: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  aggregate: z.ZodFunction<z.core.$ZodFunctionArgs, z.ZodAny>;
-}, z.core.$strip>;
-declare const BaseGeneratorConfigSchema: z.ZodUnion<readonly [z.ZodTuple<[z.ZodLiteral<"@tailor-platform/kysely-type">, z.ZodObject<{
-  distPath: z.ZodString;
-}, z.core.$strip>], null>, z.ZodTuple<[z.ZodLiteral<"@tailor-platform/seed">, z.ZodObject<{
-  distPath: z.ZodString;
-  machineUserName: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>], null>, z.ZodTuple<[z.ZodLiteral<"@tailor-platform/enum-constants">, z.ZodObject<{
-  distPath: z.ZodString;
-}, z.core.$strip>], null>, z.ZodTuple<[z.ZodLiteral<"@tailor-platform/file-utils">, z.ZodObject<{
-  distPath: z.ZodString;
-}, z.core.$strip>], null>, z.ZodObject<{
-  id: z.ZodString;
-  description: z.ZodString;
-  dependencies: z.ZodArray<z.ZodEnum<{
-    executor: "executor";
-    tailordb: "tailordb";
-    resolver: "resolver";
-  }>>;
-  processType: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processResolver: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processExecutor: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processTailorDBNamespace: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processResolverNamespace: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  aggregate: z.ZodFunction<z.core.$ZodFunctionArgs, z.ZodAny>;
-}, z.core.$strip>]>;
-/**
- * Creates a GeneratorConfigSchema with built-in generator support
- * @param builtinGenerators - Map of generator IDs to their constructor functions
- * @returns Generator config schema
- */
-declare function createGeneratorConfigSchema(builtinGenerators: Map<string, (options: any) => CodeGeneratorBase>): z.core.$ZodBranded<z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodLiteral<"@tailor-platform/kysely-type">, z.ZodObject<{
-  distPath: z.ZodString;
-}, z.core.$strip>], null>, z.ZodTuple<[z.ZodLiteral<"@tailor-platform/seed">, z.ZodObject<{
-  distPath: z.ZodString;
-  machineUserName: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>], null>, z.ZodTuple<[z.ZodLiteral<"@tailor-platform/enum-constants">, z.ZodObject<{
-  distPath: z.ZodString;
-}, z.core.$strip>], null>, z.ZodTuple<[z.ZodLiteral<"@tailor-platform/file-utils">, z.ZodObject<{
-  distPath: z.ZodString;
-}, z.core.$strip>], null>, z.ZodObject<{
-  id: z.ZodString;
-  description: z.ZodString;
-  dependencies: z.ZodArray<z.ZodEnum<{
-    executor: "executor";
-    tailordb: "tailordb";
-    resolver: "resolver";
-  }>>;
-  processType: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processResolver: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processExecutor: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processTailorDBNamespace: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  processResolverNamespace: z.ZodOptional<z.ZodFunction<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut>>;
-  aggregate: z.ZodFunction<z.core.$ZodFunctionArgs, z.ZodAny>;
-}, z.core.$strip>]>, z.ZodTransform<CodeGeneratorBase, ["@tailor-platform/kysely-type", {
-  distPath: string;
-}] | ["@tailor-platform/seed", {
-  distPath: string;
-  machineUserName?: string | undefined;
-}] | ["@tailor-platform/enum-constants", {
-  distPath: string;
-}] | ["@tailor-platform/file-utils", {
-  distPath: string;
-}] | {
-  id: string;
-  description: string;
-  dependencies: ("executor" | "tailordb" | "resolver")[];
-  aggregate: z.core.$InferOuterFunctionType<z.core.$ZodFunctionArgs, z.ZodAny>;
-  processType?: z.core.$InferOuterFunctionType<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut> | undefined;
-  processResolver?: z.core.$InferOuterFunctionType<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut> | undefined;
-  processExecutor?: z.core.$InferOuterFunctionType<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut> | undefined;
-  processTailorDBNamespace?: z.core.$InferOuterFunctionType<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut> | undefined;
-  processResolverNamespace?: z.core.$InferOuterFunctionType<z.core.$ZodFunctionArgs, z.core.$ZodFunctionOut> | undefined;
-}>>, "CodeGenerator", "out">;
-type GeneratorConfigSchemaType = ReturnType<typeof createGeneratorConfigSchema>;
-type Generator = z.output<GeneratorConfigSchemaType>;
-//#endregion
-export { ScheduleTriggerInput as C, ResolverExecutedTrigger as S, WorkflowOperation as T, FunctionOperation as _, IdPExternalConfig as a, IncomingWebhookTrigger as b, WorkflowServiceConfig as c, defineStaticWebSite as d, AuthAccessTokenTrigger as f, ExecutorServiceInput as g, ExecutorServiceConfig as h, IdPConfig as i, WorkflowServiceInput as l, ExecutorInput as m, GeneratorConfig as n, IdPInput as o, Executor as p, AppConfig as r, IdpDefinitionBrand as s, Generator as t, StaticWebsiteConfig as u, GqlOperation as v, WebhookOperation as w, RecordTrigger as x, IdpUserTrigger as y };
-//# sourceMappingURL=index-Ds8lbSJb.d.mts.map
+export { ScheduleTriggerInput as C, ResolverExecutedTrigger as S, WorkflowOperation as T, FunctionOperation as _, IdpDefinitionBrand as a, IncomingWebhookTrigger as b, CodeGeneratorBase as c, WorkflowServiceInput as d, AuthAccessTokenTrigger as f, ExecutorServiceInput as g, ExecutorServiceConfig as h, IdPInput as i, GeneratorConfig as l, ExecutorInput as m, IdPConfig as n, StaticWebsiteConfig as o, Executor as p, IdPExternalConfig as r, defineStaticWebSite as s, AppConfig as t, WorkflowServiceConfig as u, GqlOperation as v, WebhookOperation as w, RecordTrigger as x, IdpUserTrigger as y };
+//# sourceMappingURL=types-BeNtD-fA.d.mts.map

package/dist/{types-_sYDzqHG.d.mts → types-DzvazVmg.d.mts}

@@ -534,8 +534,8 @@ declare const RawPermissionsSchema: z.ZodObject<{
     }, z.core.$strict>, z.ZodString, z.ZodBoolean, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodBoolean>]>], null>>>>;
     actions: z.ZodUnion<readonly [z.ZodLiteral<"all">, z.ZodReadonly<z.ZodArray<z.ZodEnum<{
       create: "create";
-      update: "update";
       delete: "delete";
+      update: "update";
       aggregate: "aggregate";
       bulkUpsert: "bulkUpsert";
       read: "read";
@@ -951,6 +951,22 @@ type ArrayFieldOutput<T, O extends FieldOptions> = [O] extends [{
 }] ? T[] : T;
 //#endregion
 //#region src/configure/services/tailordb/permission.d.ts
+/**
+ * Record-level permission configuration for a TailorDB type.
+ * Defines create, read, update, and delete permissions.
+ *
+ * Prefer object format with explicit `conditions` and `permit` for readability.
+ * Shorthand array format is supported for compatibility, but less readable.
+ *
+ * For update operations, use `newRecord`/`oldRecord` operands instead of `record`.
+ * @example
+ * const permission: TailorTypePermission = {
+ *   create: [{ conditions: [[{ user: "_loggedIn" }, "=", true]], permit: true }],
+ *   read: [{ conditions: [[{ record: "isPublic" }, "=", true]], permit: true }],
+ *   update: [{ conditions: [[{ newRecord: "ownerId" }, "=", { user: "id" }]], permit: true }],
+ *   delete: [{ conditions: [[{ record: "ownerId" }, "=", { user: "id" }]], permit: true }],
+ * };
+ */
 type TailorTypePermission<User extends object = InferredAttributeMap, Type extends object = object> = {
   create: readonly ActionPermission<"record", User, Type, false>[];
   read: readonly ActionPermission<"record", User, Type, false>[];
@@ -1501,7 +1517,11 @@ interface TailorDBField<Defined extends DefinedDBFieldMetadata, Output> extends
     description: true;
   }>, Output>;
   /**
-   * Define a relation to another type
+   * Define a relation to another type.
+   * Relation types: "n-1" (many-to-one), "1-1" (one-to-one), "keyOnly" (key only).
+   * Aliases "manyToOne", "oneToOne", and "N-1" are also accepted.
+   * @example db.uuid().relation({ type: "n-1", toward: { type: otherModel } })
+   * @example db.uuid().relation({ type: "1-1", toward: { type: profile } })
    */
   relation<S extends RelationType, T extends TailorAnyDBType, CurrentDefined extends Defined>(this: CurrentDefined extends {
     relation: unknown;
@@ -1559,7 +1579,10 @@ interface TailorDBField<Defined extends DefinedDBFieldMetadata, Output> extends
     vector: true;
   }>, Output>;
   /**
-   * Add hooks for create/update operations
+   * Add hooks for create/update operations on this field.
+   * The hook function receives `{ value, data, user }` and returns the computed value.
+   * @example db.string().hooks({ create: ({ data }) => data.firstName + " " + data.lastName })
+   * @example db.datetime().hooks({ create: () => new Date(), update: () => new Date() })
    */
   hooks<CurrentDefined extends Defined, const H extends Hook<unknown, Output>>(this: CurrentDefined extends {
     hooks: unknown;
@@ -1577,7 +1600,15 @@ interface TailorDBField<Defined extends DefinedDBFieldMetadata, Output> extends
     serial: false;
   }>, Output>;
   /**
-   * Add validation functions to the field
+   * Add validation functions to the field.
+   * Accepts a function or a tuple of [function, errorMessage].
+   * Prefer the tuple form for diagnosable errors.
+   * @example
+   * // Function form (default error message):
+   * db.int().validate(({ value }) => value >= 0)
+   * @example
+   * // Tuple form with custom error message (recommended):
+   * db.string().validate([({ value }) => value.length >= 8, "Must be at least 8 characters"])
    */
   validate<CurrentDefined extends Defined>(this: CurrentDefined extends {
     validate: unknown;
@@ -1610,60 +1641,133 @@ interface TailorDBField<Defined extends DefinedDBFieldMetadata, Output> extends
     } ? true : Defined["array"];
   }>, FieldOutput$1<TailorToTs[Defined["type"]], NewOpt>>;
 }
+/**
+ * Create a UUID field.
+ * @param options - Field configuration options
+ * @returns A UUID field
+ * @example db.uuid()
+ * @example db.uuid({ optional: true })
+ */
 declare function uuid<const Opt extends FieldOptions>(options?: Opt): TailorDBField<{
   type: "uuid";
   array: Opt extends {
     array: true;
   } ? true : false;
 }, Opt["optional"] extends true ? ArrayFieldOutput<string, Opt> | null : ArrayFieldOutput<string, Opt>>;
+/**
+ * Create a string field.
+ * @param options - Field configuration options
+ * @returns A string field
+ * @example db.string()
+ * @example db.string({ optional: true })
+ */
 declare function string<const Opt extends FieldOptions>(options?: Opt): TailorDBField<{
   type: "string";
   array: Opt extends {
     array: true;
   } ? true : false;
 }, Opt["optional"] extends true ? ArrayFieldOutput<string, Opt> | null : ArrayFieldOutput<string, Opt>>;
+/**
+ * Create a boolean field.
+ * Note: The method name is `bool` but creates a `boolean` type field.
+ * @param options - Field configuration options
+ * @returns A boolean field
+ * @example db.bool()
+ * @example db.bool({ optional: true })
+ */
 declare function bool<const Opt extends FieldOptions>(options?: Opt): TailorDBField<{
   type: "boolean";
   array: Opt extends {
     array: true;
   } ? true : false;
 }, Opt["optional"] extends true ? ArrayFieldOutput<boolean, Opt> | null : ArrayFieldOutput<boolean, Opt>>;
+/**
+ * Create an integer field.
+ * @param options - Field configuration options
+ * @returns An integer field
+ * @example db.int()
+ * @example db.int({ optional: true })
+ */
 declare function int<const Opt extends FieldOptions>(options?: Opt): TailorDBField<{
   type: "integer";
   array: Opt extends {
     array: true;
   } ? true : false;
 }, Opt["optional"] extends true ? ArrayFieldOutput<number, Opt> | null : ArrayFieldOutput<number, Opt>>;
+/**
+ * Create a float (decimal number) field.
+ * @param options - Field configuration options
+ * @returns A float field
+ * @example db.float()
+ * @example db.float({ optional: true })
+ */
 declare function float<const Opt extends FieldOptions>(options?: Opt): TailorDBField<{
   type: "float";
   array: Opt extends {
     array: true;
   } ? true : false;
 }, Opt["optional"] extends true ? ArrayFieldOutput<number, Opt> | null : ArrayFieldOutput<number, Opt>>;
+/**
+ * Create a date field (date only, no time component).
+ * Format: "yyyy-MM-dd"
+ * @param options - Field configuration options
+ * @returns A date field
+ * @example db.date()
+ */
 declare function date<const Opt extends FieldOptions>(options?: Opt): TailorDBField<{
   type: "date";
   array: Opt extends {
     array: true;
   } ? true : false;
 }, Opt["optional"] extends true ? ArrayFieldOutput<string, Opt> | null : ArrayFieldOutput<string, Opt>>;
+/**
+ * Create a datetime field (date and time).
+ * Format: ISO 8601 "yyyy-MM-ddTHH:mm:ssZ"
+ * @param options - Field configuration options
+ * @returns A datetime field
+ * @example db.datetime()
+ */
 declare function datetime<const Opt extends FieldOptions>(options?: Opt): TailorDBField<{
   type: "datetime";
   array: Opt extends {
     array: true;
   } ? true : false;
 }, Opt["optional"] extends true ? ArrayFieldOutput<string | Date, Opt> | null : ArrayFieldOutput<string | Date, Opt>>;
+/**
+ * Create a time field (time only, no date component).
+ * Format: "HH:mm"
+ * @param options - Field configuration options
+ * @returns A time field
+ * @example db.time()
+ */
 declare function time<const Opt extends FieldOptions>(options?: Opt): TailorDBField<{
   type: "time";
   array: Opt extends {
     array: true;
   } ? true : false;
 }, Opt["optional"] extends true ? ArrayFieldOutput<string, Opt> | null : ArrayFieldOutput<string, Opt>>;
+/**
+ * Create an enum field with a fixed set of allowed string values.
+ * @param values - Array of allowed string values, or array of `{ value, description }` objects
+ * @param options - Field configuration options
+ * @returns An enum field
+ * @example db.enum(["active", "inactive", "suspended"])
+ * @example db.enum(["small", "medium", "large"], { optional: true })
+ */
 declare function _enum<const V extends AllowedValues, const Opt extends FieldOptions>(values: V, options?: Opt): TailorDBField<{
   type: "enum";
   array: Opt extends {
     array: true;
   } ? true : false;
 }, FieldOutput$1<AllowedValuesOutput<V>, Opt>>;
+/**
+ * Create a nested object field with sub-fields.
+ * @param fields - Record of nested field definitions
+ * @param options - Field configuration options
+ * @returns A nested object field
+ * @example db.object({ street: db.string(), city: db.string(), zip: db.string() })
+ * @example db.object({ name: db.string() }, { optional: true })
+ */
 declare function object<const F extends Record<string, TailorAnyDBField> & ExcludeNestedDBFields<F>, const Opt extends FieldOptions>(fields: F, options?: Opt): TailorDBField<{
   type: "nested";
   array: Opt extends {
@@ -1681,11 +1785,26 @@ interface TailorDBType$1<Fields extends Record<string, TailorAnyDBField> = any,
   /** Returns metadata for the type */
   readonly metadata: TailorDBTypeMetadata;
   /**
-   * Add hooks for fields
+   * Add hooks for fields at the type level.
+   * Each key is a field name, and the value defines create/update hooks.
+   * @example
+   * db.type("Order", {
+   *   total: db.float(),
+   *   tax: db.float(),
+   *   ...db.fields.timestamps(),
+   * }).hooks({
+   *   tax: { create: ({ data }) => data.total * 0.1, update: ({ data }) => data.total * 0.1 },
+   * })
    */
   hooks(hooks: Hooks<Fields>): TailorDBType$1<Fields, User>;
   /**
-   * Add validators for fields
+   * Add validators for fields at the type level.
+   * Each key is a field name, and the value is a validator or array of validators.
+   * Prefer the tuple form [function, message] for diagnosable errors.
+   * @example
+   * db.type("User", { email: db.string() }).validate({
+   *   email: [({ value }) => value.includes("@"), "Email must contain @"],
+   * })
    */
   validate(validators: Validators<Fields>): TailorDBType$1<Fields, User>;
   /**
@@ -1701,11 +1820,28 @@ interface TailorDBType$1<Fields extends Record<string, TailorAnyDBField> = any,
    */
   files<const F extends string>(files: Record<F, string> & Partial<Record<keyof output<TailorDBType$1<Fields, User>>, never>>): TailorDBType$1<Fields, User>;
   /**
-   * Set record-level permissions
+   * Set record-level permissions for create, read, update, and delete operations.
+   * Prefer object format with explicit `conditions` and `permit` for readability.
+   * For update operations, use `newRecord` and `oldRecord` operands.
+   * @example
+   * .permission({
+   *   create: [{ conditions: [[{ user: "_loggedIn" }, "=", true]], permit: true }],
+   *   read: [{ conditions: [[{ record: "isPublic" }, "=", true]], permit: true }],
+   *   update: [{ conditions: [[{ newRecord: "ownerId" }, "=", { user: "id" }]], permit: true }],
+   *   delete: [{ conditions: [[{ record: "ownerId" }, "=", { user: "id" }]], permit: true }],
+   * })
    */
   permission<U$1 extends object = User, P$1 extends TailorTypePermission<U$1, output<TailorDBType$1<Fields, User>>> = TailorTypePermission<U$1, output<TailorDBType$1<Fields, User>>>>(permission: P$1): TailorDBType$1<Fields, U$1>;
   /**
-   * Set GraphQL-level permissions
+   * Set GraphQL-level permissions controlling access to GraphQL operations.
+   * @example
+   * .gqlPermission([
+   *   {
+   *     conditions: [[{ user: "_loggedIn" }, "=", true]],
+   *     actions: "all",
+   *     permit: true,
+   *   },
+   * ])
    */
   gqlPermission<U$1 extends object = User, P$1 extends TailorTypeGqlPermission<U$1> = TailorTypeGqlPermission<U$1>>(permission: P$1): TailorDBType$1<Fields, U$1>;
   /**
@@ -1747,16 +1883,28 @@ type DBType<F extends {
   id: idField;
 } & F>;
 /**
- * Creates a new database type with the specified fields
+ * Creates a new database type with the specified fields.
+ * An `id` field (UUID) is automatically added to every type.
  * @param name - The name of the type, or a tuple of [name, pluralForm]
  * @param fields - The field definitions for the type
  * @returns A new TailorDBType instance
+ * @example
+ * export const user = db.type("User", {
+ *   name: db.string(),
+ *   email: db.string(),
+ *   age: db.int({ optional: true }),
+ *   role: db.enum(["admin", "member"]),
+ *   ...db.fields.timestamps(),
+ * });
+ * // Always export both the value and type:
+ * export type user = typeof user;
  */
 declare function dbType<const F extends {
   id?: never;
 } & Record<string, TailorAnyDBField>>(name: string | [string, string], fields: F): DBType<F>;
 /**
- * Creates a new database type with the specified fields and description
+ * Creates a new database type with the specified fields and description.
+ * An `id` field (UUID) is automatically added to every type.
  * @param name - The name of the type, or a tuple of [name, pluralForm]
  * @param description - A description of the type
  * @param fields - The field definitions for the type
@@ -1778,6 +1926,16 @@ declare const db: {
   enum: typeof _enum;
   object: typeof object;
   fields: {
+    /**
+     * Creates standard timestamp fields (createdAt, updatedAt) with auto-hooks.
+     * createdAt is set on create, updatedAt is set on update.
+     * @returns An object with createdAt and updatedAt fields
+     * @example
+     * const model = db.type("Model", {
+     *   name: db.string(),
+     *   ...db.fields.timestamps(),
+     * });
+     */
     timestamps: () => {
       createdAt: TailorDBField<{
         type: "datetime";
@@ -2281,4 +2439,4 @@ interface TailorDBType {
 }
 //#endregion
 export { unsafeAllowAllTypePermission as $, TailorDBField as A, PluginGeneratedExecutor as B, UserAttributeKey as C, unauthenticatedTailorUser as Ct, ValueOperand as D, UsernameFieldKey as E, TailorDBServiceInput as Et, Plugin as F, PluginOutput as G, PluginGeneratedResolver as H, PluginAttachment as I, TypePluginOutput as J, PluginProcessContext as K, PluginConfigs as L, TailorDBType$1 as M, db as N, TailorAnyDBField as O, NamespacePluginOutput as P, unsafeAllowAllGqlPermission as Q, PluginExecutorContext as R, TenantProviderConfig as S, TailorUser as St, UserAttributeMap as T, AllowedValuesOutput as Tt, PluginGeneratedType as U, PluginGeneratedExecutorWithFile as V, PluginNamespaceProcessContext as W, TailorTypeGqlPermission as X, PermissionCondition as Y, TailorTypePermission as Z, SCIMAttributeMapping as _, Env as _t, AuthInvoker as a, TailorFieldType as at, SCIMConfig as b, AttributeList as bt, BuiltinIdP as c, QueryType as ct, IdProviderConfig as d, ResolverInput as dt, ArrayFieldOutput as et, OAuth2ClientGrantType as f, ResolverServiceConfig as ft, SCIMAttribute as g, output as gt, SAML as h, JsonCompatible as ht, AuthExternalConfig as i, FieldOutput$1 as it, TailorDBInstance as j, TailorAnyDBType as k, DefinedAuth as l, Resolver as lt, OIDC as m, InferFieldsOutput as mt, TypeSourceInfoEntry as n, FieldMetadata as nt, AuthOwnConfig as o, TailorAnyField as ot, OAuth2ClientInput as p, ResolverServiceInput as pt, TailorDBTypeForPlugin as q, AuthConfig as r, FieldOptions as rt, AuthServiceInput as s, TailorField as st, TailorDBType as t, DefinedFieldMetadata as tt, IDToken as u, ResolverExternalConfig as ut, SCIMAttributeType as v, TailorEnv as vt, UserAttributeListKey as w, AllowedValues as wt, SCIMResource as x, AttributeMap as xt, SCIMAuthorization as y, TailorActor as yt, PluginExecutorContextBase as z };
-//# sourceMappingURL=types-_sYDzqHG.d.mts.map
+//# sourceMappingURL=types-DzvazVmg.d.mts.map