@cedarjs/cli 6.0.1-next.0 → 7.0.0-canary.2982

package/dist/commands/experimental/setupStreamingSsrHandler.js

@@ -183,7 +183,7 @@ You'll manually need to merge it with your existing entry.client${ext} file.`;
           fs.writeFileSync(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
         }
       },
-      addWebPackages(["@apollo/client-react-streaming@0.10.0"]),
+      addWebPackages(["@apollo/client-react-streaming@0.14.5"]),
       {
         task: () => {
           printTaskEpilogue(command, description, EXPERIMENTAL_TOPIC_ID);

package/dist/commands/generate/cell/cell.js

@@ -22,6 +22,26 @@ const builder = createBuilder({
         default: "",
         description: "Use to enforce a specific query name within the generated cell - must be unique.",
         type: "string"
+      },
+      beforeQuery: {
+        default: false,
+        description: "Include a typed `beforeQuery` stub for configuring the query (e.g. variables, fetch policy).",
+        type: "boolean"
+      },
+      afterQuery: {
+        default: false,
+        description: "Include a typed `afterQuery` stub for sanitizing data returned from the query.",
+        type: "boolean"
+      },
+      isEmpty: {
+        default: false,
+        description: "Include a typed `isEmpty` stub for overriding the default check for the Empty component.",
+        type: "boolean"
+      },
+      fragment: {
+        default: "",
+        description: "Generate a fragment cell (exports FRAGMENT instead of QUERY) that reads its data from a parent Cell, given the GraphQL type it selects from - e.g. --fragment User.",
+        type: "string"
       }
     };
   }

package/dist/commands/generate/cell/cellHandler.js

@@ -26,7 +26,11 @@ const files = async ({
   list = false,
   query,
   stories,
-  tests
+  tests,
+  beforeQuery = false,
+  afterQuery = false,
+  isEmpty = false,
+  fragment = ""
 }) => {
   let cellName = removeGeneratorName(name, "cell");
   let idName = "id";
@@ -35,22 +39,49 @@ const files = async ({
   let model = null;
   let templateNameSuffix = "";
   let typeName = cellName;
-  const shouldGenerateList = (isWordPluralizable(cellName) ? isPlural(cellName) : list) || list;
-  try {
-    model = await getSchema(pascalcase(singularize(cellName)));
-    idName = getIdName(model);
-    idType = getIdType(model);
-    typeName = model.name;
-    mockIdValues = idType === "String" ? mockIdValues.map((value) => `'${value}'`) : mockIdValues;
-  } catch {
-    idType = "Int";
+  if (fragment) {
+    if (list) {
+      throw new Error(
+        "The --list flag cannot be combined with --fragment; fragment cells always render a single item."
+      );
+    }
+    if (beforeQuery) {
+      throw new Error(
+        "The --before-query flag cannot be combined with --fragment; fragment cells never fire a query of their own."
+      );
+    }
+    if (query) {
+      throw new Error(
+        "The --query flag cannot be combined with --fragment; fragment cells don't have an operation name."
+      );
+    }
+  }
+  const shouldGenerateList = !fragment && ((isWordPluralizable(cellName) ? isPlural(cellName) : list) || list);
+  if (!fragment) {
+    try {
+      model = await getSchema(pascalcase(singularize(cellName)));
+      idName = getIdName(model);
+      idType = getIdType(model);
+      typeName = model.name;
+      mockIdValues = idType === "String" ? mockIdValues.map((value) => `'${value}'`) : mockIdValues;
+    } catch {
+      idType = "Int";
+    }
   }
   if (shouldGenerateList) {
     cellName = forcePluralizeWord(cellName);
     templateNameSuffix = "List";
   }
   let operationName = query;
-  if (operationName) {
+  let fragmentName;
+  let fragmentOnType;
+  let fragmentPropName;
+  if (fragment) {
+    const fragmentTypeVariants = nameVariants(fragment);
+    fragmentOnType = fragmentTypeVariants.pascalName;
+    fragmentPropName = fragmentTypeVariants.camelName;
+    fragmentName = `${nameVariants(cellName).pascalName}Cell_${fragmentPropName}`;
+  } else if (operationName) {
     const userSpecifiedOperationNameIsUnique = await operationNameIsUnique(operationName);
     if (!userSpecifiedOperationNameIsUnique) {
       throw new Error(`Specified query name: "${operationName}" is not unique!`);
@@ -67,11 +98,20 @@ const files = async ({
     extension,
     webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "cell",
-    templatePath: `cell${templateNameSuffix}.tsx.template`,
-    templateVars: {
+    templatePath: fragment ? "cellFragment.tsx.template" : `cell${templateNameSuffix}.tsx.template`,
+    templateVars: fragment ? {
+      fragmentName,
+      fragmentOnType,
+      camelName: fragmentPropName,
+      afterQuery,
+      isEmpty
+    } : {
       operationName,
       idName,
-      idType
+      idType,
+      beforeQuery,
+      afterQuery,
+      isEmpty
     }
   });
   const testFile = await templateForComponentFile({
@@ -80,8 +120,8 @@ const files = async ({
     extension: `.test${extension}`,
     webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "cell",
-    templatePath: "test.js.template",
-    templateVars: {
+    templatePath: fragment ? "testFragment.js.template" : "test.js.template",
+    templateVars: fragment ? { camelName: fragmentPropName } : {
       idName: shouldGenerateList ? void 0 : idName,
       mockIdValues: shouldGenerateList ? void 0 : mockIdValues
     }
@@ -92,7 +132,7 @@ const files = async ({
     extension: `.stories${extension}`,
     webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "cell",
-    templatePath: "stories.tsx.template"
+    templatePath: fragment ? "storiesFragment.tsx.template" : "stories.tsx.template"
   });
   const mockFile = await templateForComponentFile({
     name: cellName,
@@ -101,7 +141,12 @@ const files = async ({
     webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "cell",
     templatePath: `mock${templateNameSuffix}.ts.template`,
-    templateVars: {
+    templateVars: fragment ? {
+      idName,
+      mockIdValues,
+      typeName: fragmentOnType,
+      camelName: fragmentPropName
+    } : {
       idName,
       mockIdValues,
       typeName
@@ -122,7 +167,10 @@ const files = async ({
 const handler = createHandler({
   componentName: "cell",
   filesFn: files,
-  includeAdditionalTasks: ({ name: cellName }) => {
+  includeAdditionalTasks: ({
+    name: cellName,
+    fragment
+  }) => {
     return [
       {
         title: `Generating types ...`,
@@ -130,7 +178,7 @@ const handler = createHandler({
           const queryFieldName = nameVariants(
             removeGeneratorName(cellName, "cell")
           ).camelName;
-          const projectHasSdl = await checkProjectForQueryField(queryFieldName);
+          const projectHasSdl = Boolean(fragment) || await checkProjectForQueryField(queryFieldName);
           if (projectHasSdl) {
             const { errors } = await generateTypes();
             for (const { message, error } of errors) {

package/dist/commands/generate/cell/templates/cell.tsx.template

@@ -6,7 +6,9 @@ import type {
 import type {
   CellSuccessProps,
   CellFailureProps,
-  TypedDocumentNode,
+  TypedDocumentNode,<% if (beforeQuery) { %>
+  CellBeforeQueryResult,<% } %><% if (afterQuery || isEmpty) { %>
+  DataObject,<% } %>
 } from '@cedarjs/web'
 
 export const QUERY: TypedDocumentNode<
@@ -19,7 +21,24 @@ export const QUERY: TypedDocumentNode<
     }
   }
 `
-
+<% if (beforeQuery) { %>
+export const beforeQuery = (
+  props: ${operationName}Variables,
+): CellBeforeQueryResult<${operationName}Variables> => {
+  return { variables: props, fetchPolicy: 'cache-and-network' }
+}
+<% } %><% if (isEmpty) { %>
+export const isEmpty = (
+  data: DataObject,
+  { isDataEmpty }: { isDataEmpty: (data: DataObject) => boolean },
+) => {
+  return isDataEmpty(data)
+}
+<% } %><% if (afterQuery) { %>
+export const afterQuery = (data: DataObject): DataObject => {
+  return data
+}
+<% } %>
 export const Loading = () => <div>Loading...</div>
 
 export const Empty = () => <div>Empty</div>

package/dist/commands/generate/cell/templates/cellFragment.tsx.template

@@ -0,0 +1,43 @@
+import type { ${fragmentName} } from 'types/graphql'
+
+import type {
+  CellSuccessProps,<% if (afterQuery || isEmpty) { %>
+  DataObject,<% } %>
+} from '@cedarjs/web'
+
+// A parent Cell spreads this fragment by name in its own QUERY, and passes
+// the matching field down as the `${camelName}` prop - no import needed,
+// just render <${pascalName}Cell />:
+//
+//   query FindSomething($id: Int!) {
+//     something(id: $id) {
+//       id
+//       ...${fragmentName}
+//     }
+//   }
+//
+//   <${pascalName}Cell ${camelName}={something} />
+export const FRAGMENT = gql`
+  fragment ${fragmentName} on ${fragmentOnType} {
+    id
+  }
+`
+<% if (isEmpty) { %>
+export const isEmpty = (
+  data: DataObject,
+  { isDataEmpty }: { isDataEmpty: (data: DataObject) => boolean },
+) => {
+  return isDataEmpty(data)
+}
+<% } %><% if (afterQuery) { %>
+export const afterQuery = (data: DataObject): DataObject => {
+  return data
+}
+<% } %>
+export const Empty = () => <div>Empty</div>
+
+export const Success = ({
+  ${camelName},
+}: CellSuccessProps<{ ${camelName}: ${fragmentName} }>) => {
+  return <div>{JSON.stringify(${camelName})}</div>
+}

package/dist/commands/generate/cell/templates/cellList.tsx.template

@@ -3,7 +3,9 @@ import type { ${operationName}, ${operationName}Variables  } from 'types/graphql
 import type {
   CellSuccessProps,
   CellFailureProps,
-  TypedDocumentNode,
+  TypedDocumentNode,<% if (beforeQuery) { %>
+  CellBeforeQueryResult,<% } %><% if (afterQuery || isEmpty) { %>
+  DataObject,<% } %>
 } from '@cedarjs/web'
 
 export const QUERY: TypedDocumentNode<
@@ -16,7 +18,24 @@ export const QUERY: TypedDocumentNode<
     }
   }
 `
-
+<% if (beforeQuery) { %>
+export const beforeQuery = (
+  props: ${operationName}Variables,
+): CellBeforeQueryResult<${operationName}Variables> => {
+  return { variables: props, fetchPolicy: 'cache-and-network' }
+}
+<% } %><% if (isEmpty) { %>
+export const isEmpty = (
+  data: DataObject,
+  { isDataEmpty }: { isDataEmpty: (data: DataObject) => boolean },
+) => {
+  return isDataEmpty(data)
+}
+<% } %><% if (afterQuery) { %>
+export const afterQuery = (data: DataObject): DataObject => {
+  return data
+}
+<% } %>
 export const Loading = () => <div>Loading...</div>
 
 export const Empty = () => <div>Empty</div>

package/dist/commands/generate/cell/templates/storiesFragment.tsx.template

@@ -0,0 +1,23 @@
+import type { Meta, StoryObj } from '@storybook/react'
+
+import { Empty, Success } from './${pascalName}Cell'
+import { standard } from './${pascalName}Cell.mock'
+
+const meta: Meta = {
+  title: 'Cells/${pascalName}Cell',
+  tags: ['autodocs']
+}
+
+export default meta
+
+export const empty: StoryObj<typeof Empty> = {
+  render: () => {
+    return Empty ? <Empty /> : <></>
+  }
+}
+
+export const success: StoryObj<typeof Success> = {
+  render: (args) => {
+    return Success ? <Success {...standard()} {...args} /> : <></>
+  }
+}

package/dist/commands/generate/cell/templates/testFragment.js.template

@@ -0,0 +1,30 @@
+import { render } from '@cedarjs/testing/web'
+
+import { Empty, Success } from './${pascalName}Cell'
+import { standard } from './${pascalName}Cell.mock'
+
+// Generated boilerplate tests do not account for all circumstances
+// and can fail without adjustments, e.g. Float and DateTime types.
+//           Please refer to the RedwoodJS Testing Docs:
+//        https://cedarjs.com/docs/testing#testing-cells
+// https://cedarjs.com/docs/testing#jest-expect-type-considerations
+
+describe('${pascalName}Cell', () => {
+  it('renders Empty successfully', async () => {
+    expect(() => {
+      render(<Empty />)
+    }).not.toThrow()
+  })
+
+  // When you're ready to test the actual output of your component render
+  // you could test that, for example, certain text is present:
+  //
+  // 1. import { screen } from '@cedarjs/testing/web'
+  // 2. Add test: expect(screen.getByText('Hello, world')).toBeInTheDocument()
+
+  it('renders Success successfully', async () => {
+    expect(() => {
+      render(<Success ${camelName}={standard().${camelName}} />)
+    }).not.toThrow()
+  })
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cedarjs/cli",
-  "version": "6.0.1-next.0",
+  "version": "7.0.0-canary.2982",
   "description": "The CedarJS Command Line",
   "repository": {
     "type": "git",
@@ -36,17 +36,17 @@
     "@babel/preset-typescript": "7.29.7",
     "@babel/traverse": "7.29.8",
     "@babel/types": "7.29.8",
-    "@cedarjs/api-server": "6.0.1-next.0",
-    "@cedarjs/babel-config": "6.0.1-next.0",
-    "@cedarjs/cli-helpers": "6.0.1-next.0",
-    "@cedarjs/internal": "6.0.1-next.0",
-    "@cedarjs/prerender": "6.0.1-next.0",
-    "@cedarjs/project-config": "6.0.1-next.0",
-    "@cedarjs/structure": "6.0.1-next.0",
-    "@cedarjs/telemetry": "6.0.1-next.0",
-    "@cedarjs/utils": "6.0.1-next.0",
-    "@cedarjs/vite": "6.0.1-next.0",
-    "@cedarjs/web-server": "6.0.1-next.0",
+    "@cedarjs/api-server": "7.0.0-canary.2982",
+    "@cedarjs/babel-config": "7.0.0-canary.2982",
+    "@cedarjs/cli-helpers": "7.0.0-canary.2982",
+    "@cedarjs/internal": "7.0.0-canary.2982",
+    "@cedarjs/prerender": "7.0.0-canary.2982",
+    "@cedarjs/project-config": "7.0.0-canary.2982",
+    "@cedarjs/structure": "7.0.0-canary.2982",
+    "@cedarjs/telemetry": "7.0.0-canary.2982",
+    "@cedarjs/utils": "7.0.0-canary.2982",
+    "@cedarjs/vite": "7.0.0-canary.2982",
+    "@cedarjs/web-server": "7.0.0-canary.2982",
     "@listr2/prompt-adapter-enquirer": "4.3.0",
     "@opentelemetry/api": "1.9.1",
     "@opentelemetry/core": "1.30.1",
@@ -94,7 +94,7 @@
     "yargs": "17.7.3"
   },
   "devDependencies": {
-    "@cedarjs/framework-tools": "6.0.1-next.0",
+    "@cedarjs/framework-tools": "7.0.0-canary.2982",
     "@prisma/dmmf": "7.8.0",
     "@types/archiver": "^7.0.0",
     "memfs": "4.68.1",