b-gsdk 0.0.5 → 0.1.0

package/.nvmrc

@@ -0,0 +1 @@
+16

package/README.md

@@ -0,0 +1 @@
+# b-gsdk

package/dist/index.js

@@ -7,18 +7,18 @@ exports.main = void 0;
 const cli_1 = require("@graphql-codegen/cli");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const get_b_gsdk_config_1 = require("./util/get-b-gsdk-config");
 const get_b_gsdk_directory_path_1 = require("./util/get-b-gsdk-directory-path");
-async function main() {
-    const bgsdkDirectoryPath = (0, get_b_gsdk_directory_path_1.getBGsdkDirectoryPath)(process.cwd());
+async function main(args) {
+    const bgsdkDirectoryPath = (0, get_b_gsdk_directory_path_1.getBGsdkDirectoryPath)(process.cwd(), args["--dir"]);
     if (!bgsdkDirectoryPath) {
         throw new Error("Make sure you have a b-gsdk directory in the root of your project.");
     }
+    const config = (0, get_b_gsdk_config_1.getBGsdkConfig)(bgsdkDirectoryPath);
     const [schemaCodegen, sdkCodegen] = await (0, cli_1.generate)({
         schema: {
-            "https://mr-beast-2.myshopify.com/api/2021-10/graphql": {
-                headers: {
-                    "x-shopify-storefront-access-token": "374a3639228aeb7798d99d88002c4b2e",
-                },
+            [config.schemaURL]: {
+                headers: config.headers,
             },
         },
         generates: {
@@ -45,7 +45,18 @@ async function main() {
     createDirIfDoesNotExist(`${bgsdkDirectoryPath}/generated`);
     fs_1.default.writeFileSync(path_1.default.join(bgsdkDirectoryPath, "generated/graphql.schema.json"), schemaCodegen.content);
     fs_1.default.writeFileSync(path_1.default.join(bgsdkDirectoryPath, "generated/index.ts"), sdkCodegen.content);
-    fs_1.default.writeFileSync(path_1.default.join(bgsdkDirectoryPath, "sdk.ts"), sdkFileContents);
+    const skdFilePath = path_1.default.join(bgsdkDirectoryPath, "sdk.ts");
+    if (!fs_1.default.existsSync(skdFilePath)) {
+        fs_1.default.writeFileSync(skdFilePath, sdkFileContents);
+    }
+    const gitignorePath = path_1.default.join(process.cwd(), ".gitignore");
+    if (fs_1.default.existsSync(gitignorePath)) {
+        const gitignore = fs_1.default.readFileSync(gitignorePath, "utf8");
+        if (!gitignore.includes("generated")) {
+            fs_1.default.appendFileSync(gitignorePath, "\ngenerated/");
+            console.log('Added "generated/" to .gitignore');
+        }
+    }
     console.log("Done ✨");
 }
 exports.main = main;
@@ -75,4 +86,9 @@ export const createBGsdk = ({ endpoint, headers }: CreateBGsdkClientParams) => {
 
   return { ...generatedSdk, rawClient: graphQLClient }
 }
+
+// You can then create the sdk with the endpoint and headers set up and export it.
+// For example like this:
+// export const bgsdk = createBGsdk({ })
+
 `;

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "b-gsdk",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "description": "A GraphQL Codegen that outputs a TypeScript SDK.",
   "author": "Julian Benegas",
   "license": "MIT",
   "main": "dist/index.js",
   "bin": "dist/bin.js",
+  "scripts": {
+    "build": "tsc",
+    "prepublish": "yarn build"
+  },
   "dependencies": {
     "@graphql-codegen/cli": "^2.6.2",
-    "@graphql-codegen/core": "^2.5.1",
     "@graphql-codegen/introspection": "^2.1.0",
     "@graphql-codegen/typescript": "^2.4.1",
     "@graphql-codegen/typescript-graphql-request": "^4.3.2",
-    "@graphql-codegen/typescript-operations": "^2.2.1"
+    "@graphql-codegen/typescript-operations": "^2.2.1",
+    "arg": "^5.0.1",
+    "zod": "^3.14.4"
   },
   "peerDependencies": {
     "graphql": "*",
@@ -26,7 +31,7 @@
     "ts-node": "^10.7.0",
     "typescript": "^4.6.3"
   },
-  "scripts": {
-    "build": "tsc"
+  "engines": {
+    "node": ">=16.0.0"
   }
-}
+}

package/src/bin.ts

@@ -2,11 +2,14 @@
 
 import { main } from ".";
 import { formatError } from "./util/format-error";
+import arg from "arg";
 
 // Show usage and exit with code
 function help(code: number) {
   console.log(`Usage:
+  
   b-gsdk generate
+  
   `);
   process.exit(code);
 }
@@ -14,16 +17,28 @@ function help(code: number) {
 // Get CLI arguments
 const [, , cmd] = process.argv;
 
+const args = arg(
+  {
+    // types
+    "--dir": String,
+    // aliases
+    "-d": "--dir",
+  },
+  { permissive: true }
+);
+
 // CLI commands
-const cmds: { [key: string]: () => void } = {
+const cmds: { [key: string]: (args: Args) => void } = {
   generate: main,
 };
 
 // Run CLI
 try {
   // Run command or show usage for unknown command
-  cmds[cmd] ? cmds[cmd]() : help(0);
+  cmds[cmd] ? cmds[cmd](args) : help(0);
 } catch (e) {
   console.error(formatError(e).message);
   process.exit(1);
 }
+
+export type Args = typeof args;

package/src/index.ts

@@ -1,10 +1,15 @@
 import { generate } from "@graphql-codegen/cli";
 import fs from "fs";
 import path from "path";
+import { Args } from "./bin";
+import { getBGsdkConfig } from "./util/get-b-gsdk-config";
 import { getBGsdkDirectoryPath } from "./util/get-b-gsdk-directory-path";
 
-export async function main() {
-  const bgsdkDirectoryPath = getBGsdkDirectoryPath(process.cwd());
+export async function main(args: Args) {
+  const bgsdkDirectoryPath = getBGsdkDirectoryPath(
+    process.cwd(),
+    args["--dir"]
+  );
 
   if (!bgsdkDirectoryPath) {
     throw new Error(
@@ -12,14 +17,13 @@ export async function main() {
     );
   }
 
+  const config = getBGsdkConfig(bgsdkDirectoryPath);
+
   const [schemaCodegen, sdkCodegen] = await generate(
     {
       schema: {
-        "https://mr-beast-2.myshopify.com/api/2021-10/graphql": {
-          headers: {
-            "x-shopify-storefront-access-token":
-              "374a3639228aeb7798d99d88002c4b2e",
-          },
+        [config.schemaURL]: {
+          headers: config.headers,
         },
       },
       generates: {
@@ -55,7 +59,20 @@ export async function main() {
     path.join(bgsdkDirectoryPath, "generated/index.ts"),
     sdkCodegen.content
   );
-  fs.writeFileSync(path.join(bgsdkDirectoryPath, "sdk.ts"), sdkFileContents);
+  const skdFilePath = path.join(bgsdkDirectoryPath, "sdk.ts");
+  if (!fs.existsSync(skdFilePath)) {
+    fs.writeFileSync(skdFilePath, sdkFileContents);
+  }
+
+  const gitignorePath = path.join(process.cwd(), ".gitignore");
+  if (fs.existsSync(gitignorePath)) {
+    const gitignore = fs.readFileSync(gitignorePath, "utf8");
+    if (!gitignore.includes("generated")) {
+      fs.appendFileSync(gitignorePath, "\ngenerated/");
+      console.log('Added "generated/" to .gitignore');
+    }
+  }
+
   console.log("Done ✨");
 }
 
@@ -86,4 +103,9 @@ export const createBGsdk = ({ endpoint, headers }: CreateBGsdkClientParams) => {
 
   return { ...generatedSdk, rawClient: graphQLClient }
 }
+
+// You can then create the sdk with the endpoint and headers set up and export it.
+// For example like this:
+// export const bgsdk = createBGsdk({ })
+
 `;

package/src/util/get-b-gsdk-config.ts

@@ -0,0 +1,20 @@
+import fs from "fs";
+import path from "path";
+import { z } from "zod";
+
+const configSchema = z.object({
+  schemaURL: z.string(),
+  headers: z.record(z.string()),
+});
+
+export const getBGsdkConfig = (directoryPath: string) => {
+  const bgsdkConfigPath = path.join(directoryPath, "config.json");
+  if (!fs.existsSync(bgsdkConfigPath)) {
+    throw new Error(
+      `Could not find config.json in ${directoryPath}! Please create one.`
+    );
+  }
+  const rawConfig = JSON.parse(fs.readFileSync(bgsdkConfigPath, "utf8"));
+  const parsedConfig = configSchema.parse(rawConfig);
+  return parsedConfig;
+};

package/src/util/get-b-gsdk-directory-path.ts

@@ -1,9 +1,8 @@
 import fs from "fs";
 import path from "path";
 
-// taken from prisma https://github.com/prisma/prisma/blob/8f6b7c7c99c1c720cf5bfed5d563423e71c1b84f/packages/sdk/src/cli/getSchema.ts#L46-L49
-export const getBGsdkDirectoryPath = (cwd: string) => {
-  const schemaPath = path.join(cwd, "b-gsdk");
+export const getBGsdkDirectoryPath = (cwd: string, customDir?: string) => {
+  const schemaPath = path.join(cwd, customDir || "b-gsdk");
   if (fs.existsSync(schemaPath)) {
     return schemaPath;
   }

package/tsconfig.json

@@ -13,6 +13,7 @@
   },
   "compilerOptions": {
     "rootDir": "src",
-    "outDir": "dist"
+    "outDir": "dist",
+    "strict": true
   }
 }

package/dist/bin.js

@@ -1,27 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const _1 = require(".");
-const format_error_1 = require("./util/format-error");
-// Show usage and exit with code
-function help(code) {
-    console.log(`Usage:
-  b-gsdk generate
-  `);
-    process.exit(code);
-}
-// Get CLI arguments
-const [, , cmd] = process.argv;
-// CLI commands
-const cmds = {
-    generate: _1.main,
-};
-// Run CLI
-try {
-    // Run command or show usage for unknown command
-    cmds[cmd] ? cmds[cmd]() : help(0);
-}
-catch (e) {
-    console.error((0, format_error_1.formatError)(e).message);
-    process.exit(1);
-}

package/dist/util/format-error.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatError = void 0;
-const formatError = (error) => {
-    if (error instanceof Error) {
-        return error;
-    }
-    if (typeof error === "string") {
-        return new Error(error);
-    }
-    if (typeof error === "object") {
-        return new Error(JSON.stringify(error, null, 2));
-    }
-    return new Error(`Unknown error: ${error}`);
-};
-exports.formatError = formatError;

package/dist/util/get-b-gsdk-directory-path.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBGsdkDirectoryPath = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-// taken from prisma https://github.com/prisma/prisma/blob/8f6b7c7c99c1c720cf5bfed5d563423e71c1b84f/packages/sdk/src/cli/getSchema.ts#L46-L49
-const getBGsdkDirectoryPath = (cwd) => {
-    const schemaPath = path_1.default.join(cwd, "b-gsdk");
-    if (fs_1.default.existsSync(schemaPath)) {
-        return schemaPath;
-    }
-    return null;
-};
-exports.getBGsdkDirectoryPath = getBGsdkDirectoryPath;