Merge pull request #629 from Shopify/liz/update-docs

Fix various docs issues

.changeset/big-humans-tease.md

@@ -0,0 +1,2 @@
+---
+---

packages/.prettierrc

@@ -0,0 +1 @@
+"@shopify/prettier-config"

packages/shopify-app-remix/src/server/authenticate/admin/billing/types.ts

@@ -104,7 +104,7 @@ export interface BillingContext<Config extends AppConfigArg> {
    * ```
    *
    * @example
-   * <caption>Using a plan selection page.</caption>
+   * <caption>Redirect to a plan selection page.</caption>
    * <description> When the app has multiple plans, create a page in your App that allows the merchant to select a plan. If a merchant does not have the required plan you can redirect them to page in your app to select one.</description>
    * ```ts
    * // /app/routes/**\/*.ts

packages/shopify-app-remix/src/server/clients/admin/types.ts

@@ -161,6 +161,18 @@ export interface AdminApiContext<
    *   return json({ data: productData.data });
    * }
    * ```
+   *
+   * ```ts
+   * // /app/shopify.server.ts
+   * import { shopifyApp } from "@shopify/shopify-app-remix/server";
+   *
+   * const shopify = shopifyApp({
+   *   restResources,
+   *   // ...etc
+   * });
+   * export default shopify;
+   * export const unauthenticated = shopify.unauthenticated;
+   * ```
    */
   graphql: GraphQLClient<AdminOperations>;
 }

packages/shopify-app-remix/src/server/types.ts

@@ -229,7 +229,7 @@ export interface ShopifyAppBase<Config extends AppConfigArg> {
    * import prisma from "~/db.server";
    *
    * const shopify = shopifyApp({
-   *   sesssionStorage: new PrismaSessionStorage(prisma),
+   *   sessionStorage: new PrismaSessionStorage(prisma),
    *   // ...etc
    * })
    *

packages/shopify-app-remix/src/server/unauthenticated/admin/types.ts

@@ -32,6 +32,82 @@ export interface UnauthenticatedAdminContext<
 
   /**
    * Methods for interacting with the GraphQL / REST Admin APIs for the given store.
+   *
+   * @example
+   * <caption>Performing a GET request to the REST API.</caption>
+   * <description>Use `admin.rest.get` to make custom requests to make a request to to the `customer/count` endpoint</description>
+   *
+   * ```ts
+   * // /app/routes/**\/*.ts
+   * import { LoaderFunctionArgs, json } from "@remix-run/node";
+   * import { unauthenticated } from "../shopify.server";
+   *
+   * export const loader = async ({ request }: LoaderFunctionArgs) => {
+   *  const { admin, session } = await unauthenticated.admin(request);
+   *
+   *  const response = await admin.rest.get(
+   *    {
+   *      path: "/customers/count.json"
+   *    }
+   *  );
+   *  const customers = await response.json();
+   *
+   *  return json({ customers });
+   * };
+   * ```
+   *
+   * ```ts
+   * // /app/shopify.server.ts
+   * import { shopifyApp } from "@shopify/shopify-app-remix/server";
+   * import { restResources } from "@shopify/shopify-api/rest/admin/2023-04";
+   *
+   * const shopify = shopifyApp({
+   *  restResources,
+   *  // ...etc
+   * });
+   *
+   * export default shopify;
+   * export const unauthenticated = shopify.unauthenticated;
+   * ```
+   * @example
+   * <caption>Querying the GraphQL API.</caption>
+   * <description>Use `admin.graphql` to make query / mutation requests.</description>
+   * ```ts
+   * // /app/routes/**\/*.ts
+   * import { ActionFunctionArgs } from "@remix-run/node";
+   * import { unauthenticated } from "../shopify.server";
+   *
+   * export async function action({ request }: ActionFunctionArgs) {
+   *  const { admin } = await unauthenticated.admin(request);
+   *
+   *  const response = await admin.graphql(
+   *    `#graphql
+   *    mutation populateProduct($input: ProductInput!) {
+   *      productCreate(input: $input) {
+   *        product {
+   *          id
+   *        }
+   *      }
+   *     }`,
+   *     { variables: { input: { title: "Product Name" } } }
+   *   );
+   *
+   *  const productData = await response.json();
+   *  return json({ data: productData.data });
+   * }
+   * ```
+   *
+   * ```ts
+   * // /app/shopify.server.ts
+   * import { shopifyApp } from "@shopify/shopify-app-remix/server";
+   *
+   * const shopify = shopifyApp({
+   *  restResources,
+   *  // ...etc
+   * });
+   * export default shopify;
+   * export const unauthenticated = shopify.unauthenticated;
+   * ```
    */
   admin: AdminApiContext<Resources>;
 }

packages/shopify-app-remix/src/server/unauthenticated/admin/unauthenticated.admin.doc.ts

@@ -17,7 +17,7 @@ const data: ReferenceEntityTemplateSchema = {
       type: 'GetUnauthenticatedAdminContext',
     },
   ],
-  jsDocTypeExamples: ['UnauthenticatedAdminContext', 'AdminApiContext'],
+  jsDocTypeExamples: ['UnauthenticatedAdminContext'],
   related: [
     {
       name: 'API context',