@dittowords/cli 4.5.2 → 5.0.0-beta.1

package/lib/http/importComponents.ts

@@ -1,79 +0,0 @@
-import { createApiClient } from "../api";
-import FormData from "form-data";
-import fs from "fs";
-
-export interface ImportComponentResponse {
-  componentsInserted: number;
-  firstImportedId: string;
-}
-
-export interface CsvColumnMapping {
-  text: number;
-  name: string;
-  notes?: number;
-  tags?: number;
-  status?: number;
-  componentId?: number;
-}
-
-export async function importComponents(
-  path: string,
-  options: {
-    csvColumnMapping?: CsvColumnMapping;
-  }
-): Promise<ImportComponentResponse> {
-  const api = createApiClient();
-
-  if (!fs.existsSync(path)) {
-    console.error("Failed to import file: couldn't find file at path " + path);
-    return {
-      componentsInserted: 0,
-      firstImportedId: "null",
-    };
-  }
-
-  const form = new FormData();
-  form.append("import", fs.createReadStream(path));
-
-  const requestOptions = {
-    method: "POST",
-    url: "/v1/components/file",
-    params: {
-      ...(options.csvColumnMapping?.name
-        ? { name: `[${options.csvColumnMapping.name}]` }
-        : {}),
-      ...(options.csvColumnMapping?.text
-        ? { text: options.csvColumnMapping.text }
-        : {}),
-      ...(options.csvColumnMapping?.notes
-        ? { notes: options.csvColumnMapping.notes }
-        : {}),
-      ...(options.csvColumnMapping?.status
-        ? { status: options.csvColumnMapping.status }
-        : {}),
-      ...(options.csvColumnMapping?.tags
-        ? { tags: options.csvColumnMapping.tags }
-        : {}),
-      ...(options.csvColumnMapping?.componentId
-        ? { componentId: options.csvColumnMapping.componentId }
-        : {}),
-    },
-    headers: {
-      "content-type": "multipart/form-data",
-    },
-    data: form,
-  };
-
-  try {
-    const { data } = await api(requestOptions);
-
-    return data;
-  } catch (e: any) {
-    console.error("Failed to import file.");
-    console.error(e.response?.data?.message || e.message);
-    return {
-      componentsInserted: 0,
-      firstImportedId: "null",
-    };
-  }
-}

package/lib/importComponents.ts

@@ -1,24 +0,0 @@
-import {
-  CsvColumnMapping,
-  importComponents as importComponentsHttp,
-} from "./http/importComponents";
-
-async function importComponents(
-  filePath: string,
-  options: {
-    csvColumnMapping?: CsvColumnMapping;
-  }
-) {
-  if (
-    filePath.endsWith(".csv") &&
-    (!options.csvColumnMapping?.name || !options.csvColumnMapping?.text)
-  ) {
-    throw new Error(
-      ".csv files require the --component-name and --text flags."
-    );
-  }
-  const importResult = await importComponentsHttp(filePath, options);
-  console.log(JSON.stringify(importResult));
-}
-
-export { importComponents };

package/lib/init/init.ts

@@ -1,79 +0,0 @@
-// Related to initializing a user/environment to ditto.
-// expected to be run once per project.
-import boxen from "boxen";
-import chalk from "chalk";
-import projectsToText from "../utils/projectsToText";
-
-import { needsSource, collectAndSaveSource } from "./project";
-import { needsToken, collectAndSaveToken } from "./token";
-
-import config from "../config";
-import output from "../output";
-import sourcesToText from "../utils/sourcesToText";
-import { quit } from "../utils/quit";
-
-export const needsTokenOrSource = () => needsToken() || needsSource();
-
-function welcome() {
-  const msg = chalk.white(`${chalk.bold(
-    "Welcome to the",
-    chalk.magentaBright("Ditto CLI")
-  )}.
-
-We're glad to have you here.`);
-  console.log(boxen(msg, { padding: 1 }));
-}
-
-export const init = async () => {
-  welcome();
-
-  if (needsToken()) {
-    await collectAndSaveToken();
-  }
-
-  const {
-    hasSourceData,
-    validProjects,
-    shouldFetchComponentLibrary,
-    hasTopLevelComponentsField,
-    hasTopLevelProjectsField,
-  } = config.parseSourceInformation();
-
-  if (hasTopLevelProjectsField) {
-    return await quit(`${output.errorText(
-      `Support for ${output.warnText(
-        "projects"
-      )} as a top-level field has been removed; please configure ${output.warnText(
-        "sources.projects"
-      )} instead.`
-    )}
-See ${output.url("https://github.com/dittowords/cli")} for more information.`);
-  }
-
-  if (hasTopLevelComponentsField) {
-    return await quit(
-      `${output.errorText(
-        "Support for `components` as a top-level field has been removed; please configure `sources.components` instead."
-      )}
-See ${output.url("https://github.com/dittowords/cli")} for more information.`
-    );
-  }
-
-  if (!hasSourceData) {
-    console.log(
-      `Looks like there are no Ditto sources selected for your current directory: ${output.info(
-        process.cwd()
-      )}.`
-    );
-    await collectAndSaveSource({ initialize: true, components: true });
-    return;
-  }
-
-  const message =
-    "You're currently set up to sync text from " +
-    sourcesToText(validProjects, shouldFetchComponentLibrary);
-
-  console.log(message);
-};
-
-export default { init };

package/lib/init/project.test.ts

@@ -1,26 +0,0 @@
-const fs = require("fs");
-const yaml = require("js-yaml");
-
-import { _testing } from "./project";
-
-const fakeProjectDir = "/";
-
-jest.mock("fs");
-
-describe("saveProject", () => {
-  const configFile = "/ditto/config.yml";
-  const projectName = "My Amazing Project";
-  const projectId = "5f284259ce1d451b2eb2e23c";
-
-  beforeEach(() => {
-    _testing.saveProject(configFile, projectName, projectId);
-  });
-
-  it("creates a config file with config data", () => {
-    const fileContents = fs.readFileSync(configFile, "utf8");
-    const data = yaml.load(fileContents);
-    expect(data.sources.projects).toBeDefined();
-    expect(data.sources.projects[0].name).toEqual(projectName);
-    expect(data.sources.projects[0].id).toEqual(projectId);
-  });
-});

package/lib/init/project.ts

@@ -1,136 +0,0 @@
-import ora from "ora";
-
-import { createApiClient } from "../api";
-import config from "../config";
-import consts from "../consts";
-import output from "../output";
-import { collectAndSaveToken } from "./token";
-import {
-  getSelectedProjects,
-  getIsUsingComponents,
-} from "../utils/getSelectedProjects";
-import promptForProject from "../utils/promptForProject";
-import { AxiosResponse } from "axios";
-import { Project, Token } from "../types";
-import { quit } from "../utils/quit";
-
-function saveProject(file: string, name: string, id: string) {
-  if (id === "components") {
-    config.writeProjectConfigData(file, {
-      sources: { components: true },
-    });
-    return;
-  }
-
-  const projects = [...getSelectedProjects(file), { name, id }];
-  config.writeProjectConfigData(file, { sources: { projects } });
-}
-
-export const needsSource = () => {
-  return !config.parseSourceInformation().hasSourceData;
-};
-
-async function askForAnotherToken() {
-  config.deleteToken(consts.CONFIG_FILE, consts.API_HOST);
-  const message =
-    "Looks like the API key you have saved no longer works. Please enter another one.";
-  await collectAndSaveToken(message);
-}
-
-async function listProjects(token: Token, projectsAlreadySelected: Project[]) {
-  const api = createApiClient();
-  const spinner = ora("Fetching sources in your workspace...");
-  spinner.start();
-
-  let response: AxiosResponse<{ id: string; name: string }[]>;
-  try {
-    response = await api.get("/v1/projects");
-  } catch (e) {
-    spinner.stop();
-    throw e;
-  }
-
-  const projectsAlreadySelectedSet = projectsAlreadySelected.reduce(
-    (set, project) => set.add(project.id.toString()),
-    new Set<string>()
-  );
-
-  const result = response.data.filter(
-    ({ id }) =>
-      // covers an edge case where v0 of the API includes the component library
-      // in the response from the `/project-names` endpoint
-      id !== "ditto_component_library" &&
-      !projectsAlreadySelectedSet.has(id.toString())
-  );
-
-  spinner.stop();
-
-  return result;
-}
-
-async function collectSource(token: Token, includeComponents: boolean) {
-  const projectsAlreadySelected = getSelectedProjects();
-  const componentSourceSelected = getIsUsingComponents();
-
-  let sources = await listProjects(token, projectsAlreadySelected);
-  if (includeComponents && !componentSourceSelected) {
-    sources = [
-      { id: "ditto_component_library", name: "Ditto Component Library" },
-      ...sources,
-    ];
-  }
-
-  if (!sources?.length) {
-    console.log("You're currently syncing all projects in your workspace.");
-    console.log(
-      output.warnText(
-        "Not seeing a project that you were expecting? Verify that developer mode is enabled on that project. More info: https://www.dittowords.com/docs/ditto-developer-mode"
-      )
-    );
-    return null;
-  }
-
-  return promptForProject({
-    projects: sources,
-    message: "Choose the source you'd like to sync text from",
-  });
-}
-
-export const collectAndSaveSource = async (
-  { components = false }: { initialize?: boolean; components?: boolean } = {
-    components: false,
-  }
-) => {
-  try {
-    const token = config.getToken(consts.CONFIG_FILE, consts.API_HOST);
-    const project = await collectSource(token, components);
-    if (!project) {
-      await quit(null, 0);
-      return;
-    }
-
-    console.log(
-      "\n" +
-        `Thanks for adding ${output.info(
-          project.name
-        )} to your selected sources.\n` +
-        `We saved your updated configuration to: ${output.info(
-          consts.PROJECT_CONFIG_FILE
-        )}\n`
-    );
-
-    saveProject(consts.PROJECT_CONFIG_FILE, project.name, project.id);
-  } catch (e: any) {
-    console.log(e);
-    if (e.response && e.response.status === 404) {
-      await askForAnotherToken();
-      await collectAndSaveSource({ components });
-    } else {
-      await quit(null, 2);
-    }
-  }
-};
-
-export const _testing = { saveProject, needsSource };
-
-export default { needsSource, collectAndSaveSource };

package/lib/init/token.test.ts

@@ -1,99 +0,0 @@
-import fs from "fs";
-import config from "../config";
-import { randomUUID } from "crypto";
-import { needsToken } from "./token";
-import { _test } from "./token";
-import { vol } from "memfs";
-import { jest } from "@jest/globals";
-import axios from "axios";
-
-jest.mock("fs");
-jest.mock("../api");
-
-const axiosMocked = jest.mocked(axios);
-
-const defaultEnv = { ...process.env };
-
-beforeEach(() => {
-  vol.reset();
-  process.env = { ...defaultEnv };
-});
-
-describe("needsToken", () => {
-  it("is true if there is no config file", () => {
-    expect(needsToken(randomUUID())).toBeTruthy();
-  });
-
-  it("is false if there is a token in the environment", () => {
-    process.env.DITTO_API_KEY = "xxx-xxx-xxx";
-    expect(needsToken(randomUUID())).toBe(false);
-  });
-
-  describe("with a config file", () => {
-    let configFile = "";
-
-    beforeEach(async () => {
-      configFile = `/${randomUUID()}`;
-      await new Promise((resolve, reject) =>
-        fs.writeFile(configFile, "", (err) => {
-          if (err) reject(err);
-          else {
-            resolve(null);
-          }
-        })
-      );
-    });
-
-    it("returns true if empty", () => {
-      expect(needsToken(configFile, "testing.dittowords.com")).toBeTruthy();
-    });
-
-    describe("with some data", () => {
-      beforeEach(() => {
-        config.saveToken(configFile, "badtesting.dittowords.com", "faketoken");
-      });
-
-      it("is true if there is no entries for our API host", () => {
-        expect(needsToken(configFile, "testing.dittowords.com")).toBeTruthy();
-      });
-
-      it("is false if we have a token listed", () => {
-        config.saveToken(configFile, "testing.dittowords.com", "faketoken");
-        expect(needsToken(configFile, "testing.dittowords.com")).toBeFalsy();
-      });
-    });
-
-    it("is true if there is no token listed", () => {
-      const configNoToken = "../../testing/fixtures/ditto-config-no-token";
-      expect(needsToken(configNoToken, "testing.dittowords.com")).toBeTruthy();
-    });
-
-    it("is strips the protocol when writing an entry", () => {
-      config.saveToken(
-        configFile,
-        "https://testing.dittowords.com",
-        "faketoken"
-      );
-      expect(needsToken(configFile, "testing.dittowords.com")).toBeFalsy();
-    });
-  });
-});
-
-const { verifyTokenUsingTokenCheck } = _test;
-describe("verifyTokenUsingTokenCheck", () => {
-  it("returns success: true for api success response", async () => {
-    axiosMocked.get.mockResolvedValueOnce({ status: 200 });
-    const result = await verifyTokenUsingTokenCheck("xxx-xxx");
-    expect(result.success).toBe(true);
-  });
-  it("returns success: false for api unauthorized response", async () => {
-    axiosMocked.get.mockResolvedValueOnce({ status: 401 });
-    const result = await verifyTokenUsingTokenCheck("xxx-xxx");
-    expect(result.success).toBe(false);
-  });
-  it("returns success: false for api invalid response", async () => {
-    axiosMocked.get.mockResolvedValueOnce("error");
-    const result = await verifyTokenUsingTokenCheck("xxx-xxx");
-    expect(result.success).toBe(false);
-  });
-});

package/lib/init/token.ts

@@ -1,156 +0,0 @@
-import fs from "fs";
-import * as Sentry from "@sentry/node";
-
-import chalk from "chalk";
-
-import { prompt } from "enquirer";
-
-import { createApiClient } from "../api";
-import consts from "../consts";
-import output from "../output";
-import config from "../config";
-import { quit } from "../utils/quit";
-import { AxiosError, AxiosResponse } from "axios";
-
-export const needsToken = (configFile?: string, host = consts.API_HOST) => {
-  if (config.getTokenFromEnv()) {
-    return false;
-  }
-
-  const file = configFile || consts.CONFIG_FILE;
-  if (!fs.existsSync(file)) return true;
-  const configData = config.readGlobalConfigData(file);
-  if (
-    !configData[config.justTheHost(host)] ||
-    configData[config.justTheHost(host)][0].token === ""
-  )
-    return true;
-  return false;
-};
-
-async function verifyTokenUsingTokenCheck(
-  token: string
-): Promise<{ success: true } | { success: false; output: string[] }> {
-  const axios = createApiClient(token);
-  const endpoint = "/token-check";
-
-  let resOrError: AxiosResponse<any> | undefined;
-  try {
-    resOrError = await axios.get(endpoint);
-  } catch (e: unknown) {
-    if (!(e instanceof AxiosError)) {
-      return {
-        success: false,
-        output: [
-          output.warnText(
-            "Sorry! We're having trouble reaching the Ditto API."
-          ),
-        ],
-      };
-    }
-
-    if (e.code === "ENOTFOUND") {
-      return {
-        success: false,
-        output: [
-          output.errorText(
-            `Can't connect to API: ${output.url(consts.API_HOST)}`
-          ),
-        ],
-      };
-    }
-
-    if (e.response?.status === 401 || e.response?.status === 404) {
-      return {
-        success: false,
-        output: [
-          output.errorText("This API key isn't valid. Please try another."),
-        ],
-      };
-    }
-  }
-
-  if (typeof resOrError === "string") {
-    return {
-      success: false,
-      output: [resOrError],
-    };
-  }
-
-  if (resOrError?.status === 200) {
-    return { success: true };
-  }
-
-  return {
-    success: false,
-    output: [output.errorText("This API key isn't valid. Please try another.")],
-  };
-}
-
-// Returns true if valid, otherwise an error message.
-async function checkToken(token: string): Promise<any> {
-  const result = await verifyTokenUsingTokenCheck(token);
-  if (!result.success) {
-    return result.output.join("\n");
-  }
-
-  return true;
-}
-
-async function collectToken(message: string | null) {
-  const blue = output.info;
-  const apiUrl = output.url("https://app.dittowords.com/account/devtools");
-  const breadcrumbs = `${chalk.bold(blue("API Keys"))}`;
-  const tokenDescription =
-    message ||
-    `To get started, you'll need your Ditto API key. You can find this at: ${apiUrl} under "${breadcrumbs}".`;
-  console.log(tokenDescription);
-
-  const response = await prompt<{ token: string }>({
-    type: "input",
-    name: "token",
-    message: "What is your API key?",
-    validate: (token) => checkToken(token),
-  });
-  return response.token;
-}
-
-/**
- *
- * @param {string | null} message
- * @returns
- */
-export const collectAndSaveToken = async (message: string | null = null) => {
-  try {
-    const token = await collectToken(message);
-    console.log(
-      `Thanks for authenticating.  We'll save the key to: ${output.info(
-        consts.CONFIG_FILE
-      )}`
-    );
-    output.nl();
-
-    config.saveToken(consts.CONFIG_FILE, consts.API_HOST, token);
-    return token;
-  } catch (error) {
-    // https://github.com/enquirer/enquirer/issues/225#issue-516043136
-    // Empty string corresponds to the user hitting Ctrl + C
-    if (error === "") {
-      await quit("", 0);
-      return;
-    }
-
-    const eventId = Sentry.captureException(error);
-    const eventStr = `\n\nError ID: ${output.info(eventId)}`;
-
-    return await quit(
-      output.errorText(
-        "Something went wrong. Please contact support or try again later."
-      ) + eventStr
-    );
-  }
-};
-
-export default { needsToken, collectAndSaveToken };
-
-export const _test = { verifyTokenUsingTokenCheck };

package/lib/output.ts

@@ -1,21 +0,0 @@
-import chalk from "chalk";
-
-export const errorText = (msg: string) => chalk.magenta(msg);
-export const warnText = (msg: string) => chalk.yellow(msg);
-export const info = (msg: string) => chalk.blueBright(msg);
-export const success = (msg: string) => chalk.green(msg);
-export const url = (msg: string) => chalk.blueBright.underline(msg);
-export const subtle = (msg: string) => chalk.grey(msg);
-export const write = (msg: string) => chalk.white(msg);
-export const nl = () => console.log("\n");
-
-export default {
-  errorText,
-  warnText,
-  info,
-  success,
-  url,
-  subtle,
-  write,
-  nl,
-};