Argument of type '"markDefs[]"' is not assignable to parameter of type 'never'.

[tobeycodes]

Is there an existing issue for this?

• I have searched the existing issues

Code of Conduct

• I agree to follow this project's Code of Conduct

Code Sandbox link

No response

Bug report

I am working on building out a scaffold for sanity projects and I have been experimenting with groqd for better type saftey over groq. Here is where the issue exists https://github.com/vueza/create-sanity-app/blob/feature/groqd/apps/cms/src/fragments/block.ts#L11

I am extracting the content block type used with portable text and created a fragment for this. When trying to get the field markDefs[] I get the error Argument of type '"markDefs[]"' is not assignable to parameter of type 'never'.. Typically the autocomplete would show all the possible fields but for me fieldName is never.

If I copy the actual type extracted (as I have shown below the commented out Extract) the same error exists but the error goes away if I remove _type: "block". The field(fieldName) then autocompletes all the fields and the type error for markDefs[] goes away.

import type { InferFragmentType } from "groqd";
import { z } from "zod";
import type { internalGroqTypeReferenceTo } from "../../sanity.types";
import { q } from "../client/client";
import { link } from "./link";

//type Block = Extract<Content[number], { _type: "block" }>;

type Block = {
  children?: Array<{
    marks?: Array<string>;
    text?: string;
    _type: "span";
    _key: string;
  }>;
  style?: "normal" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "blockquote";
  listItem?: "bullet" | "number";
  markDefs?: Array<{
    type: "href" | "page" | "post";
    href?: string;
    page?: {
      _ref: string;
      _type: "reference";
      _weak?: boolean;
      [internalGroqTypeReferenceTo]?: "page";
    };
    post?: {
      _ref: string;
      _type: "reference";
      _weak?: boolean;
      [internalGroqTypeReferenceTo]?: "post";
    };
    _type: "link";
    _key: string;
  }>;
  level?: number;
  _type: "block";
  _key: string;
};

export const block = q.fragment<Block>().project((sub) => ({
  "...": true,
  markDefs: sub.field("markDefs[]").project((sub) => ({
    _key: z.string(),
    ...sub.conditionalByType({
      link: {
        _key: z.string(),
        ...link,
      },
    }),
  })),
}));

export type BlockFragment = InferFragmentType<typeof block>;

[tobeycodes]

I reviewed the code a little and found this. So maybe this is intentional.

groqd/packages/groqd/src/types/projection-paths.ts

Line 20 in 2cfb58f

| { _type: "block" };

The reason I do this is to have links in block content and the link href is determined by the groq query instead of the FE code.

https://github.com/vueza/create-sanity-app/blob/d8863f1e9b0ebed1a84d55ca022d0a6afde0fc53/apps/cms/src/fragments/link.ts

https://github.com/vueza/create-sanity-app/blob/feature/groqd/apps/cms/src/objects/content.ts#L14

[tobeycodes]

@scottrippey Will you accept a pull request for this? Or you prefer to leave it like it is?

[scottrippey]

@tobeycodes I'd be happy to have a PR for this! I'm going to try to reproduce now.
I found the problem, and am looking for a solution now.

[scottrippey]

So to explain the original intent:

• The field method and project methods are typed so they only allow valid paths, like "images[].asset"
• All these types will appear in auto-complete, which can get overwhelming.
• So for certain common types (slug, block, and reference), we don't want to show a million uncommon deep options (like slug._type block.children[].marks[], or reference._weak). So we hide those.
• However, as you found, hiding these everywhere is not a great choice.

So I just created #373, which disables this "ignore" behavior, only when we're at the top level:

q.fragmentForType<"article">().project((article) => ({
  // This still won't work, we prevent this overly-deep nesting:
  content: article.field("content[].markDefs[]"),

  // but this will:
  content: article.field("content[]").field("markDefs[]"),
  // and more importantly, this will work:
  content: article.field("content[]").project(block => ({
    children: "children[]",
    markDefs: block.field("markDefs[]").project(/*...*/)
  }),
});

[tobeycodes]

@scottrippey Thank you! This looks great. Based on your last content example this should work great for me based on the one I currently have.

https://github.com/vueza/create-sanity-app/blob/feature/groqd/apps/cms/src/fragments/content.ts
https://github.com/vueza/create-sanity-app/blob/feature/groqd/apps/cms/src/fragments/block.ts