@shopify/cli-kit 0.8.0

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@shopify/cli-kit",
+  "version": "0.8.0",
+  "private": false,
+  "description": "A set of utilities, interfaces, and models that are common across all the platform features",
+  "keywords": [
+    "shopify",
+    "shopify-cli",
+    "shopify-partners"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "/src",
+    "/npm-shrinkwrap.json"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "@shopify:registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "clean": "shx rm -rf dist",
+    "build": "shx rm -rf dist && rollup -c",
+    "prepublishOnly": "yarn run build",
+    "lint": "prettier -c src/** && eslint src/**",
+    "lint:fix": "prettier src/** && eslint src/** --fix",
+    "test": "shx rm -rf dist && vitest run",
+    "test:watch": "vitest watch",
+    "tsc": "tsc -b"
+  },
+  "eslintConfig": {
+    "extends": [
+      "../../package.json"
+    ]
+  },
+  "engine-strict": true,
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "devDependencies": {
+    "@types/inquirer": "^8.2.0",
+    "camelcase": "^6.3.0",
+    "fast-glob": "^3.2.11",
+    "find-up": "^6.2.0",
+    "inquirer": "^8.2.0",
+    "liquidjs": "^9.34.0",
+    "param-case": "^3.0.4",
+    "pathe": "^0.2.0",
+    "picocolors": "^1.0.0",
+    "term-size": "^3.0.1"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,11 @@
+const constants = {
+  environmentVariables: {
+    config: 'SHOPIFY_CONFIG',
+    partnersApiEnv: 'SHOPIFY_PARTNERS_API_ENV',
+    adminApiEnv: 'SHOPIFY_ADMIN_API_ENV',
+    storefrontRendererApiEnv: 'SHOPIFY_STOREFRONT_RENDERER_API_ENV',
+    identityEnv: 'SHOPIFY_IDENTITY_ENV',
+  },
+};
+
+export default constants;

package/src/environment.test.ts

@@ -0,0 +1,221 @@
+import {expect, it, describe} from 'vitest';
+
+import {
+  isDebug,
+  isRelease,
+  partnersApiEnvironment,
+  adminApiEnvironment,
+  storefrontRendererApiEnvironment,
+  identityEnvironment,
+} from './environment';
+import {Environment} from './network/service';
+
+describe('isDebug', () => {
+  it('returns true when SHOPIFY_CONFIG is debug', () => {
+    // Given
+    const env = {SHOPIFY_CONFIG: 'debug'};
+
+    // When
+    const got = isDebug(env);
+
+    // Then
+    expect(got).toBe(true);
+  });
+});
+
+describe('isRelease', () => {
+  it("returns true when SHOPIFY_CONFIG isn't defined", () => {
+    // Given
+    const env = {};
+
+    // When
+    const got = isRelease(env);
+
+    // Then
+    expect(got).toBe(true);
+  });
+});
+
+describe('partnersApiEnvironment', () => {
+  it('returns local when the environment variable points to the local environment', () => {
+    // Given
+    const env = {SHOPIFY_PARTNERS_API_ENV: 'local'};
+
+    // When
+    const got = partnersApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Local);
+  });
+
+  it('returns Spin when the environment variable points to the spin environment', () => {
+    // Given
+    const env = {SHOPIFY_PARTNERS_API_ENV: 'spin'};
+
+    // When
+    const got = partnersApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Spin);
+  });
+
+  it('returns Production when the environment variable points to the production environment', () => {
+    // Given
+    const env = {SHOPIFY_PARTNERS_API_ENV: 'production'};
+
+    // When
+    const got = partnersApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Production);
+  });
+
+  it("returns Production when the environment variable doesn't exist", () => {
+    // Given
+    const env = {};
+
+    // When
+    const got = partnersApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Production);
+  });
+});
+
+describe('adminApiEnvironment', () => {
+  it('returns local when the environment variable points to the local environment', () => {
+    // Given
+    const env = {SHOPIFY_ADMIN_API_ENV: 'local'};
+
+    // When
+    const got = adminApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Local);
+  });
+
+  it('returns Spin when the environment variable points to the spin environment', () => {
+    // Given
+    const env = {SHOPIFY_ADMIN_API_ENV: 'spin'};
+
+    // When
+    const got = adminApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Spin);
+  });
+
+  it('returns Production when the environment variable points to the production environment', () => {
+    // Given
+    const env = {SHOPIFY_ADMIN_API_ENV: 'production'};
+
+    // When
+    const got = adminApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Production);
+  });
+
+  it("returns Production when the environment variable doesn't exist", () => {
+    // Given
+    const env = {};
+
+    // When
+    const got = adminApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Production);
+  });
+});
+
+describe('storefrontRendererApiEnvironment', () => {
+  it('returns local when the environment variable points to the local environment', () => {
+    // Given
+    const env = {SHOPIFY_STOREFRONT_RENDERER_API_ENV: 'local'};
+
+    // When
+    const got = storefrontRendererApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Local);
+  });
+
+  it('returns Spin when the environment variable points to the spin environment', () => {
+    // Given
+    const env = {SHOPIFY_STOREFRONT_RENDERER_API_ENV: 'spin'};
+
+    // When
+    const got = storefrontRendererApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Spin);
+  });
+
+  it('returns Production when the environment variable points to the production environment', () => {
+    // Given
+    const env = {SHOPIFY_STOREFRONT_RENDERER_API_ENV: 'production'};
+
+    // When
+    const got = storefrontRendererApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Production);
+  });
+
+  it("returns Production when the environment variable doesn't exist", () => {
+    // Given
+    const env = {};
+
+    // When
+    const got = storefrontRendererApiEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Production);
+  });
+});
+
+describe('identityEnvironment', () => {
+  it('returns local when the environment variable points to the local environment', () => {
+    // Given
+    const env = {SHOPIFY_IDENTITY_ENV: 'local'};
+
+    // When
+    const got = identityEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Local);
+  });
+
+  it('returns Spin when the environment variable points to the spin environment', () => {
+    // Given
+    const env = {SHOPIFY_IDENTITY_ENV: 'spin'};
+
+    // When
+    const got = identityEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Spin);
+  });
+
+  it('returns Production when the environment variable points to the production environment', () => {
+    // Given
+    const env = {SHOPIFY_IDENTITY_ENV: 'production'};
+
+    // When
+    const got = identityEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Production);
+  });
+
+  it("returns Production when the environment variable doesn't exist", () => {
+    // Given
+    const env = {};
+
+    // When
+    const got = identityEnvironment(env);
+
+    // Then
+    expect(got).toBe(Environment.Production);
+  });
+});

package/src/environment.ts

@@ -0,0 +1,72 @@
+import constants from './constants';
+import {Environment} from './network/service';
+
+/**
+ * Given an environment variable that represents the environment to use for a given serve,
+ * it returns the environment as a enum;
+ * @param value The environment variable value.
+ * @returns {ServiceEnvironment} representing the environment to use.
+ */
+function serviceEnvironment(value: undefined | string): Environment {
+  if (value === 'local') {
+    return Environment.Local;
+  } else if (value === 'spin') {
+    return Environment.Spin;
+  } else {
+    return Environment.Production;
+  }
+}
+
+/**
+ * Returns true if the CLI is running in debug mode.
+ * @param env The environment variables from the environment of the current process.
+ * @returns true if SHOPIFY_CONFIG is debug
+ */
+export function isDebug(env = process.env): boolean {
+  return env[constants.environmentVariables.config] === 'debug';
+}
+
+/**
+ * Returns true if the CLI is running in release mode.
+ * @param env The environment variables from the environment of the current process.
+ * @returns true if SHOPIFY_CONFIG isn't debug
+ */
+export function isRelease(env = process.env): boolean {
+  return env[constants.environmentVariables.config] !== 'debug';
+}
+
+/**
+ * Returns the environment to be used for the interactions with the partners' CLI API.
+ * @param env The environment variables from the environment of the current process.
+ */
+export function partnersApiEnvironment(env = process.env): Environment {
+  return serviceEnvironment(env[constants.environmentVariables.partnersApiEnv]);
+}
+
+/**
+ * Returns the environment to be used for the interactions with the admin API.
+ * @param env The environment variables from the environment of the current process.
+ */
+export function adminApiEnvironment(env = process.env): Environment {
+  return serviceEnvironment(env[constants.environmentVariables.adminApiEnv]);
+}
+
+/**
+ * Returns the environment to be used for the interactions with the storefront renderer API.
+ * @param env The environment variables from the environment of the current process.
+ */
+export function storefrontRendererApiEnvironment(
+  env = process.env,
+): Environment {
+  return serviceEnvironment(
+    env[constants.environmentVariables.storefrontRendererApiEnv],
+  );
+}
+
+/**
+ * Returns the environment to be used for the interactions with identity.
+ * @param env The environment variables from the environment of the current process.
+ */
+export function identityEnvironment(env = process.env): Environment {
+  return serviceEnvironment(env[constants.environmentVariables.identityEnv]);
+}

package/src/error.ts

@@ -0,0 +1,22 @@
+/**
+ * A fatal error represents an error shouldn't be rescued and that causes the execution to terminate.
+ * There shouldn't be code that catches fatal errors.
+ */
+export class Fatal extends Error {
+  tryMessage: string | null;
+  constructor(message: string, tryMessage: string | null = null) {
+    super(message);
+    this.tryMessage = tryMessage;
+  }
+}
+
+/**
+ * An abort error is a fatal error that shouldn't be reported as a bug.
+ * Those usually represent unexpected scenarios that we can't handle and that usually require some action from the developer
+ */
+export class Abort extends Fatal {}
+
+/**
+ * A bug error is an error that represents a bug and therefore should be reported.
+ */
+export class Bug extends Fatal {}

package/src/fs.ts

@@ -0,0 +1,12 @@
+import fs from 'fs';
+import type {PathLike} from 'fs';
+
+export const readFile = async (path: string) => {
+  return fs.promises.readFile(path, {encoding: 'utf-8'});
+};
+
+export const write = async (path: PathLike, data: string) => {
+  return fs.promises.writeFile(path, data);
+};
+
+export const isDirectory = (path: string) => fs.lstatSync(path).isDirectory();

package/src/index.ts

@@ -0,0 +1,8 @@
+export * as ui from './ui';
+export * as error from './error';
+export * as system from './system';
+export {template} from './template';
+export * as string from './string';
+export * as path from './path';
+export * as fs from './fs';
+export * as output from './output';

package/src/network/service.ts

@@ -0,0 +1,22 @@
+/**
+ * Enum for the differnet APIs the CLI can interact with.
+ * @readonly
+ * @enum {number}
+ */
+export enum Service {
+  PartnersApi = 'partners-api',
+  StorefrontRendererApi = 'storefront-renderer-api',
+  AdminApi = 'admin-api',
+  IdentityApi = 'identity-api',
+}
+
+/**
+ * Enum that represents the environment to use for a given service.
+ * @readonly
+ * @enum {number}
+ */
+export enum Environment {
+  Local = 'local',
+  Production = 'production',
+  Spin = 'spin',
+}

package/src/output.ts

@@ -0,0 +1,61 @@
+import pc from 'picocolors';
+
+enum ContentTokenType {
+  Command,
+  Path,
+}
+
+class ContentToken {
+  type: ContentTokenType;
+  value: string;
+
+  constructor(value: string, type: ContentTokenType) {
+    this.type = type;
+    this.value = value;
+  }
+}
+
+export const token = {
+  command: (value: string) => {
+    return new ContentToken(value, ContentTokenType.Command);
+  },
+  path: (value: string) => {
+    return new ContentToken(value, ContentTokenType.Path);
+  },
+};
+
+// output.content`Something ${output.token.command(Something)}`
+
+class Message {
+  value: string;
+  constructor(value: string) {
+    this.value = value;
+  }
+}
+
+export function content(
+  strings: TemplateStringsArray,
+  ...keys: ContentToken[]
+): Message {
+  let output = ``;
+  strings.forEach((string, i) => {
+    output += string;
+    if (i >= keys.length) {
+      return;
+    }
+    const token = keys[i];
+    switch (token.type) {
+      case ContentTokenType.Command:
+        output += pc.bold(token.value);
+        break;
+      case ContentTokenType.Path:
+        output += pc.italic(token.value);
+        break;
+    }
+  });
+  return new Message(output);
+}
+
+export const success = (content: Message) => {
+  console.log(pc.green(`🎉 ${content.value}`));
+};

package/src/path.ts

@@ -0,0 +1,3 @@
+export * from 'pathe';
+export {findUp} from 'find-up';
+export {default as glob} from 'fast-glob';

package/src/prompt.ts

@@ -0,0 +1,4 @@
+import inquirer from 'inquirer';
+
+const prompt: typeof inquirer = inquirer;
+export default prompt;

package/src/session/authenticate.ts

@@ -0,0 +1,3 @@
+const authenticate = () => {};
+
+export default authenticate;

package/src/session/identity.ts

@@ -0,0 +1,44 @@
+import {Abort, Bug} from '../error';
+import {
+  adminApiEnvironment,
+  partnersApiEnvironment,
+  storefrontRendererApiEnvironment,
+} from '../environment';
+import {Environment, Service} from '../network/service';
+
+export function applicationId(service: Service): string {
+  switch (service) {
+    case Service.AdminApi: {
+      const environment = adminApiEnvironment();
+      if (environment === Environment.Local) {
+        return 'e92482cebb9bfb9fb5a0199cc770fde3de6c8d16b798ee73e36c9d815e070e52';
+      } else if (environment === Environment.Production) {
+        return '7ee65a63608843c577db8b23c4d7316ea0a01bd2f7594f8a9c06ea668c1b775c';
+      } else {
+        throw new Abort(`Spin is not yet supported for the Shopify Admin API`);
+      }
+    }
+    case Service.PartnersApi: {
+      const environment = partnersApiEnvironment();
+      if (environment === Environment.Local) {
+        return 'df89d73339ac3c6c5f0a98d9ca93260763e384d51d6038da129889c308973978';
+      } else if (environment === Environment.Production) {
+        return '271e16d403dfa18082ffb3d197bd2b5f4479c3fc32736d69296829cbb28d41a6';
+      } else {
+        throw new Abort(`Spin is not yet supported for the Partners API`);
+      }
+    }
+    case Service.StorefrontRendererApi: {
+      const environment = storefrontRendererApiEnvironment();
+      if (environment === Environment.Local) {
+        return '46f603de-894f-488d-9471-5b721280ff49';
+      } else if (environment === Environment.Production) {
+        return 'ee139b3d-5861-4d45-b387-1bc3ada7811c';
+      } else {
+        throw new Abort(`Spin is not yet supported for the Partners API`);
+      }
+    }
+    default:
+      throw new Bug(`Application id for service of type: ${service}`);
+  }
+}

package/src/string.ts

@@ -0,0 +1,2 @@
+export {default as camelize} from 'camelcase';
+export {paramCase as hyphenize} from 'param-case';

package/src/system.ts

@@ -0,0 +1,5 @@
+import fs from 'fs';
+
+export async function mkdir(path: fs.PathLike) {
+  return fs.promises.mkdir(path, {recursive: true});
+}

package/src/template.ts

@@ -0,0 +1,9 @@
+import {Liquid} from 'liquidjs';
+
+// This line is necessary to register additional helpers.
+export function template(templateContent: string) {
+  return (data: object): Promise<string> => {
+    const engine = new Liquid();
+    return engine.render(engine.parse(templateContent), data);
+  };
+}

package/src/ui.ts

@@ -0,0 +1,9 @@
+import inquirer from 'inquirer';
+import type {Answers, QuestionCollection} from 'inquirer';
+
+export const prompt = <T extends Answers = Answers>(
+  questions: QuestionCollection<T>,
+  initialAnswers?: Partial<T>,
+): Promise<T> => {
+  return inquirer.prompt(questions, initialAnswers);
+};