Merge pull request #59 from pantheon-systems/PCC-555-adjust-nextjs-st…

…arter-kit-tests-js-ts Make nextjs starter kit tests more useful. Solve some SDK typescript problems.
pantheon-systems · Sep 13, 2023 · 3b97d98 · 3b97d98
2 parents 980fb0b + 00e3424
commit 3b97d98
Show file tree

Hide file tree

Showing 64 changed files with 132 additions and 5,710 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,11 @@
 node_modules/
+yarn.lock
+yarn-error.log
+package-lock.json
+
 .env.local
+.env.development
+.env.production
+
 .turbo
 .DS_Store
-yarn-error.log
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -2,7 +2,7 @@
   "name": "@pantheon-systems/pcc-cli",
   "author": "@pantheon-systems",
   "description": "Pantheon Content Cloud CLI",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "type": "module",
   "license": "MIT",
   "keywords": [

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -2,7 +2,7 @@
   "name": "@pantheon-systems/pcc-sdk-core",
   "author": "@pantheon-systems",
   "description": "Pantheon Content Cloud SDK Core",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

diff --git a/packages/core/src/helpers/articles.ts b/packages/core/src/helpers/articles.ts
@@ -18,27 +18,39 @@ export interface ArticleQueryArgs {
 }
 
 type FilterableFields = "body" | "tag" | "title";
-export type ArticleSearchArgs = { [key in FilterableFields]: string };
+
+export type ArticleSearchArgs = {
+  bodyContains?: string;
+  tagContains?: string;
+  titleContains?: string;
+};
+
 type ConvertedArticleSearchArgs = {
-  [key in FilterableFields]: { contains: string };
+  [key in FilterableFields]: { contains: string } | undefined;
 };
 
 export function convertSearchParamsToGQL(
   searchParams?: ArticleSearchArgs,
 ): { filter: ConvertedArticleSearchArgs } | null {
   if (!searchParams) return null;
 
-  // Cast empty object to workaround Typescript bug
-  // https://stackoverflow.com/questions/15877362/declare-and-initialize-a-dictionary-in-typescript
-  const convertedObject: ConvertedArticleSearchArgs =
-    {} as ConvertedArticleSearchArgs;
-
-  Object.keys(searchParams).forEach(
-    (k) =>
-      (convertedObject[k.replace("Contains", "") as FilterableFields] = {
-        contains: searchParams[k as FilterableFields],
-      }),
-  );
+  const convertedObject: ConvertedArticleSearchArgs = {
+    body: searchParams.bodyContains
+      ? {
+          contains: searchParams.bodyContains,
+        }
+      : undefined,
+    tag: searchParams.tagContains
+      ? {
+          contains: searchParams.tagContains,
+        }
+      : undefined,
+    title: searchParams.titleContains
+      ? {
+          contains: searchParams.titleContains,
+        }
+      : undefined,
+  };
 
   return Object.keys(convertedObject).length
     ? { filter: convertedObject }
@@ -60,12 +72,12 @@ export async function getArticles(
 
 export async function getArticle(
   client: PantheonClient,
-  id: string,
+  id: number | string,
   args?: ArticleQueryArgs,
 ) {
   const article = await client.apolloClient.query({
     query: GET_ARTICLE_QUERY,
-    variables: { id, ...args },
+    variables: { id: id.toString(), ...args },
   });
 
   return article.data.article as Article;
@@ -86,13 +98,13 @@ export async function getArticleBySlug(
 
 export async function getArticleBySlugOrId(
   client: PantheonClient,
-  slugOrId: string,
+  slugOrId: number | string,
   args?: ArticleQueryArgs,
 ) {
   // First attempt to retrieve by slug, and fallback to by id if the matching slug
   // couldn't be found.
   try {
-    const article = await getArticleBySlug(client, slugOrId, args);
+    const article = await getArticleBySlug(client, slugOrId.toString(), args);
 
     if (article) {
       return article;

diff --git a/packages/react-sdk/package.json b/packages/react-sdk/package.json
@@ -2,7 +2,7 @@
   "name": "@pantheon-systems/pcc-react-sdk",
   "author": "@pantheon-systems",
   "description": "Pantheon Content Cloud React SDK",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "license": "MIT",
   "keywords": [
     "pcc",

diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.ts
@@ -1,4 +1,6 @@
+export type { PantheonClientConfig } from "@pantheon-systems/pcc-sdk-core";
 export { PantheonClient } from "@pantheon-systems/pcc-sdk-core";
+
 export {
   getArticles,
   getArticle,

diff --git a/packages/vue-sdk/package.json b/packages/vue-sdk/package.json
@@ -2,7 +2,7 @@
   "name": "@pantheon-systems/pcc-vue-sdk",
   "author": "@pantheon-systems",
   "description": "Pantheon Content Cloud Vue SDK",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",

diff --git a/starters/gatsby-starter/src/components/seo.jsx b/starters/gatsby-starter/src/components/seo.jsx
@@ -1,3 +1,5 @@
+import React from 'react';
+
 const defaultMeta = {
   type: "website",
   robots: "follow, index",
@@ -12,6 +14,7 @@ export default function Seo({ title, description, tags, authors, date }) {
     tags,
     date,
   };
+
   return (
     <head>
       <title>{meta.title}</title>

diff --git a/starters/nextjs-starter-ts/__tests__/data/article.json b/starters/nextjs-starter-ts/__tests__/data/article.json
diff --git a/starters/nextjs-starter-ts/__tests__/data/articles.json b/starters/nextjs-starter-ts/__tests__/data/articles.json