@molecule/api-resource 1.0.5 → 1.0.7

package/README.md

@@ -3,7 +3,7 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
 Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
 Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
 To change this document, edit the module-level JSDoc in src/index.ts.
-Generated: 2026-10-17T04:45:43.913Z
+Generated: 2026-10-26T04:23:42.740Z
 -->
 
 # @molecule/api-resource
@@ -307,11 +307,14 @@ export const create = ({ name, tableName, schema }: types.Resource) => {
 ```
 
 ```typescript
-function create({
+function create<
+  CreateProps extends Record<string, unknown> = Record<string, unknown>,
+  CreatedProps extends types.Props & CreateProps = types.Props & CreateProps,
+>({
   name,
   tableName,
   schema,
-}: types.Resource<unknown>): ({
+}: types.Resource): ({
   props: createProps,
   id,
 }: {
@@ -372,7 +375,13 @@ export const del = ({ name, tableName, schema }: types.Resource) => {
 ```
 
 ```typescript
-function del({ name, tableName }: DeletedResource): ({ id }: { id: Props['id'] }) => Promise<
+function del<
+  Props extends types.Props = types.Props,
+  DeletedResource extends types.Resource<Props> = types.Resource<Props>,
+>({
+  name,
+  tableName,
+}: DeletedResource): ({ id }: { id: Props['id'] }) => Promise<
   | { statusCode: number; body: { error: string; errorKey: string; props?: undefined } }
   | {
       statusCode: number
@@ -394,7 +403,10 @@ Creates a request handler to be used to query resources.
 Uses the bonded DataStore from `@molecule/api-database` for database-agnostic operations.
 
 ```typescript
-function query({
+function query<
+  Props extends types.Props = types.Props,
+  QueriedResource extends types.Resource = types.Resource,
+>({
   tableName,
 }: QueriedResource): (
   req: MoleculeRequest,
@@ -432,7 +444,10 @@ export const read = ({ name, tableName, schema }: types.Resource) => {
 ```
 
 ```typescript
-function read({
+function read<
+  ReadProps extends types.Props = types.Props,
+  ReadResource extends types.Resource<ReadProps> = types.Resource<ReadProps>,
+>({
   tableName,
 }: ReadResource): ({
   id,
@@ -504,11 +519,18 @@ export const update = ({ name, tableName, schema }: types.Resource) => {
 ```
 
 ```typescript
-function update({
+function update<
+  UpdateProps extends Record<string, unknown> = Record<string, unknown>,
+  UpdatedProps extends Pick<types.Props, `updatedAt`> & UpdateProps = Pick<
+    types.Props,
+    `updatedAt`
+  > &
+    UpdateProps,
+>({
   name,
   tableName,
   schema,
-}: types.Resource<unknown>): ({
+}: types.Resource): ({
   id,
   props: updateProps,
 }: {
@@ -597,9 +619,7 @@ Creates a Zod schema for the standard `{ statusCode, body }` response
 returned by resource CRUD operations.
 
 ```typescript
-function responseSchema(
-  propsSchema: T,
-): z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>
+function responseSchema<T extends z.ZodTypeAny>(propsSchema: T): z.ZodTypeAny
 ```
 
 - `propsSchema` — The Zod schema for the resource's props (e.g. `userPropsSchema`).
@@ -612,9 +632,7 @@ Creates a Zod schema that validates a resource descriptor object
 (`{ name, tableName, schema }`).
 
 ```typescript
-function resourceSchema(
-  _propsSchema: T,
-): z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>
+function resourceSchema<T extends z.ZodTypeAny>(_propsSchema: T): z.ZodTypeAny
 ```
 
 - `_propsSchema` — The Zod schema for the resource's props (used for type inference only).
@@ -627,10 +645,7 @@ Validates data against a Zod schema, throwing an `Error` with a
 human-readable message listing all validation failures if invalid.
 
 ```typescript
-function validate(
-  schema: z.ZodType<T, unknown, z.core.$ZodTypeInternals<T, unknown>>,
-  data: unknown,
-): T
+function validate<T>(schema: z.ZodSchema<T>, data: unknown): T
 ```
 
 - `schema` — The Zod schema to validate against.
@@ -644,8 +659,8 @@ Validates data against a Zod schema without throwing. Returns a discriminated
 union: `{ success: true, data }` on success or `{ success: false, error }` on failure.
 
 ```typescript
-function safeParse(
-  schema: z.ZodType<T, unknown, z.core.$ZodTypeInternals<T, unknown>>,
+function safeParse<T>(
+  schema: z.ZodSchema<T>,
   data: unknown,
 ): { success: true; data: T } | { success: false; error: z.ZodError }
 ```
@@ -661,9 +676,9 @@ Creates a schema where all fields are optional, suitable for validating
 partial update payloads where only changed fields are sent.
 
 ```typescript
-function partial(
-  schema: z.ZodObject<T, z.core.$strip>,
-): z.ZodObject<{ [K in keyof T]: z.ZodOptional<T[K]> }, z.core.$strip>
+function partial<T extends z.ZodRawShape>(
+  schema: z.ZodObject<T>,
+): z.ZodObject<{ [K in keyof T]: z.ZodOptional<T[K]> }>
 ```
 
 - `schema` — The Zod object schema to make partial.
@@ -676,10 +691,10 @@ Creates a schema with only the specified fields, useful for create payloads
 where only a subset of the full props should be provided by the client.
 
 ```typescript
-function pick(
-  schema: z.ZodObject<T, z.core.$strip>,
+function pick<T extends z.ZodRawShape, K extends keyof T>(
+  schema: z.ZodObject<T>,
   keys: readonly K[],
-): z.ZodObject<Pick<T, K>, z.core.$strip>
+): z.ZodObject<Pick<T, K>>
 ```
 
 - `schema` — The Zod object schema to pick from.
@@ -797,6 +812,16 @@ interface Response<T = unknown> {
 
 Re-exported as a namespace — reach every member below through it (e.g. `utilities.<name>`).
 
+##### `utilities.ZodSchema` _(deprecated)_
+
+```typescript
+type ZodSchema<
+  Output = unknown,
+  Input = unknown,
+  Internals extends core.$ZodTypeInternals<Output, Input> = core.$ZodTypeInternals<Output, Input>,
+> = ZodType<Output, Input, Internals>
+```
+
 ##### `utilities.ZodError`
 
 An Error-like class used to store Zod validation issues.
@@ -818,151 +843,6 @@ interface ZodError<T = unknown> extends $ZodError<T> {
 }
 ```
 
-##### `utilities.ZodSchema`
-
-````typescript
-interface ZodType<
-  out Output = unknown,
-  out Input = unknown,
-  out Internals extends core.$ZodTypeInternals<Output, Input> = core.$ZodTypeInternals<
-    Output,
-    Input
-  >,
-> extends core.$ZodType<Output, Input, Internals> {
-  def: Internals['def']
-  type: Internals['def']['type']
-  /** @deprecated Use `.def` instead. */
-  _def: Internals['def']
-  /** @deprecated Use `z.output<typeof schema>` instead. */
-  _output: Internals['output']
-  /** @deprecated Use `z.input<typeof schema>` instead. */
-  _input: Internals['input']
-  '~standard': ZodStandardSchemaWithJSON<this>
-  /** Converts this schema to a JSON Schema representation. */
-  toJSONSchema(params?: core.ToJSONSchemaParams): core.ZodStandardJSONSchemaPayload<this>
-  check(...checks: (core.CheckFn<core.output<this>> | core.$ZodCheck<core.output<this>>)[]): this
-  with(...checks: (core.CheckFn<core.output<this>> | core.$ZodCheck<core.output<this>>)[]): this
-  clone(
-    def?: Internals['def'],
-    params?: {
-      parent: boolean
-    },
-  ): this
-  register<R extends core.$ZodRegistry>(
-    registry: R,
-    ...meta: this extends R['_schema']
-      ? undefined extends R['_meta']
-        ? [core.$replace<R['_meta'], this>?]
-        : [core.$replace<R['_meta'], this>]
-      : ['Incompatible schema']
-  ): this
-  brand<T extends PropertyKey = PropertyKey, Dir extends 'in' | 'out' | 'inout' = 'out'>(
-    value?: T,
-  ): PropertyKey extends T ? this : core.$ZodBranded<this, T, Dir>
-  parse(data: unknown, params?: core.ParseContext<core.$ZodIssue>): core.output<this>
-  safeParse(
-    data: unknown,
-    params?: core.ParseContext<core.$ZodIssue>,
-  ): parse.ZodSafeParseResult<core.output<this>>
-  parseAsync(data: unknown, params?: core.ParseContext<core.$ZodIssue>): Promise<core.output<this>>
-  safeParseAsync(
-    data: unknown,
-    params?: core.ParseContext<core.$ZodIssue>,
-  ): Promise<parse.ZodSafeParseResult<core.output<this>>>
-  spa: (
-    data: unknown,
-    params?: core.ParseContext<core.$ZodIssue>,
-  ) => Promise<parse.ZodSafeParseResult<core.output<this>>>
-  encode(data: core.output<this>, params?: core.ParseContext<core.$ZodIssue>): core.input<this>
-  decode(data: core.input<this>, params?: core.ParseContext<core.$ZodIssue>): core.output<this>
-  encodeAsync(
-    data: core.output<this>,
-    params?: core.ParseContext<core.$ZodIssue>,
-  ): Promise<core.input<this>>
-  decodeAsync(
-    data: core.input<this>,
-    params?: core.ParseContext<core.$ZodIssue>,
-  ): Promise<core.output<this>>
-  safeEncode(
-    data: core.output<this>,
-    params?: core.ParseContext<core.$ZodIssue>,
-  ): parse.ZodSafeParseResult<core.input<this>>
-  safeDecode(
-    data: core.input<this>,
-    params?: core.ParseContext<core.$ZodIssue>,
-  ): parse.ZodSafeParseResult<core.output<this>>
-  safeEncodeAsync(
-    data: core.output<this>,
-    params?: core.ParseContext<core.$ZodIssue>,
-  ): Promise<parse.ZodSafeParseResult<core.input<this>>>
-  safeDecodeAsync(
-    data: core.input<this>,
-    params?: core.ParseContext<core.$ZodIssue>,
-  ): Promise<parse.ZodSafeParseResult<core.output<this>>>
-  refine<Ch extends (arg: core.output<this>) => unknown | Promise<unknown>>(
-    check: Ch,
-    params?: string | core.$ZodCustomParams,
-  ): Ch extends (arg: any) => arg is infer R ? this & ZodType<R, core.input<this>> : this
-  superRefine(
-    refinement: (
-      arg: core.output<this>,
-      ctx: core.$RefinementCtx<core.output<this>>,
-    ) => void | Promise<void>,
-    params?: core.$ZodSuperRefineParams,
-  ): this
-  overwrite(fn: (x: core.output<this>) => core.output<this>): this
-  optional(): ZodOptional<this>
-  exactOptional(): ZodExactOptional<this>
-  nonoptional(params?: string | core.$ZodNonOptionalParams): ZodNonOptional<this>
-  nullable(): ZodNullable<this>
-  nullish(): ZodOptional<ZodNullable<this>>
-  default(def: util.NoUndefined<core.output<this>>): ZodDefault<this>
-  default(def: () => util.NoUndefined<core.output<this>>): ZodDefault<this>
-  prefault(def: () => core.input<this>): ZodPrefault<this>
-  prefault(def: core.input<this>): ZodPrefault<this>
-  array(): ZodArray<this>
-  or<T extends core.SomeType>(option: T): ZodUnion<[this, T]>
-  and<T extends core.SomeType>(incoming: T): ZodIntersection<this, T>
-  transform<NewOut>(
-    transform: (
-      arg: core.output<this>,
-      ctx: core.$RefinementCtx<core.output<this>>,
-    ) => NewOut | Promise<NewOut>,
-  ): ZodPipe<this, ZodTransform<Awaited<NewOut>, core.output<this>>>
-  catch(def: core.output<this>): ZodCatch<this>
-  catch(def: (ctx: core.$ZodCatchCtx) => core.output<this>): ZodCatch<this>
-  pipe<T extends core.$ZodType<any, core.output<this>>>(
-    target: T | core.$ZodType<any, core.output<this>>,
-  ): ZodPipe<this, T>
-  readonly(): ZodReadonly<this>
-  /** Returns a new instance that has been registered in `z.globalRegistry` with the specified description */
-  describe(description: string): this
-  description?: string
-  /** Returns the metadata associated with this instance in `z.globalRegistry` */
-  meta(): core.$replace<core.GlobalMeta, this> | undefined
-  /** Returns a new instance that has been registered in `z.globalRegistry` with the specified metadata */
-  meta(data: core.$replace<core.GlobalMeta, this>): this
-  /** @deprecated Try safe-parsing `undefined` (this is what `isOptional` does internally):
-   *
-   * ```ts
-   * const schema = z.string().optional();
-   * const isOptional = schema.safeParse(undefined).success; // true
-   * ```
-   */
-  isOptional(): boolean
-  /**
-   * @deprecated Try safe-parsing `null` (this is what `isNullable` does internally):
-   *
-   * ```ts
-   * const schema = z.string().nullable();
-   * const isNullable = schema.safeParse(null).success; // true
-   * ```
-   */
-  isNullable(): boolean
-  apply<T>(fn: (schema: this) => T): T
-}
-````
-
 ##### `utilities.getValidProps`
 
 Validates resource props against a Zod schema, returning typed valid props or throwing
@@ -974,8 +854,17 @@ const getValidProps: <Props>({
   schema,
   props,
 }: {
+  /**
+   * The name of the resource (used in error messages).
+   */
   name: string
+  /**
+   * The Zod schema used when validating props.
+   */
   schema: ZodSchema<Props>
+  /**
+   * The `props` to be validated.
+   */
   props: unknown
 }) => Props
 ```
@@ -995,7 +884,15 @@ Validates data against a Zod schema without throwing, returning a discriminated
 const safeParse: <T>(
   schema: ZodSchema<T>,
   data: unknown,
-) => { success: true; data: T } | { success: false; error: ZodError }
+) =>
+  | {
+      success: true
+      data: T
+    }
+  | {
+      success: false
+      error: ZodError
+    }
 ```
 
 - `schema` — The Zod schema to validate against.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@molecule/api-resource",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Resource CRUD operations and utilities for molecule.dev.",
   "type": "module",
   "main": "dist/index.js",
@@ -35,17 +35,17 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "uuid": "14.0.1",
-    "zod": "4.4.3"
+    "uuid": "14.0.3",
+    "zod": "4.6.7"
   },
   "devDependencies": {
-    "@molecule/api-bond": "1.0.2",
-    "@molecule/api-database": "1.1.3",
+    "@molecule/api-bond": "1.0.4",
+    "@molecule/api-database": "1.2.1",
     "@molecule/api-locales-resource": "1.0.2",
-    "@molecule/api-utilities-validation": "1.0.2",
-    "@types/node": "26.1.2",
+    "@molecule/api-utilities-validation": "1.0.4",
+    "@types/node": "26.6.5",
     "typescript": "6.0.3",
-    "vitest": "4.1.11"
+    "vitest": "4.1.12"
   },
   "peerDependencies": {
     "@molecule/api-bond": "^1.0.1",