Configure Space with YAML Plugin

[madaley1]

Guide: https://flatfile.com/docs/plugins/schemas/convert-yaml-schema

Kitchen Sink: WIP

This PR introduces the @flatfile/plugin-convert-yaml-schema plugin to configure a Flatfile Space based on a provided YAML Schema. The usage for this plugin closely mirrors @flatfile/plugin-convert-json-schema.

Basic Usage

listener.use(
  configureSpaceWithYamlSchema(
    [{ sourceUrl:'https://example.com/customer.schema.yaml' }]
  )
)

Advanced Usage

import api, { Flatfile } from "@flatfile/api";
import type { FlatfileEvent, FlatfileListener } from "@flatfile/listener";
import {
  ModelToSheetConfig,
  PartialWorkbookConfig,
  configureSpaceWithYamlSchema,
} from "@flatfile/plugin-convert-yaml-schema";

export default function (listener: FlatfileListener) {
  const workbookActions: Flatfile.Action[] = [
    {
      operation: "submitActionFg",
      mode: "foreground",
      label: "Submit data",
      type: "string",
      description: "Submit this data to a webhook.",
      primary: true,
    },
  ];

  const sheetActions: Flatfile.Action[] = [
    {
      operation: "duplicateSheet",
      mode: "foreground",
      label: "Duplicate",
      description: "Duplicate this sheet.",
      primary: true,
    },
  ];

  const callback = async (
    event: FlatfileEvent,
    workbookIds: string[],
    tick: (progress?: number, message?: string) => Promise<Flatfile.JobResponse>
  ) => {
    const { spaceId } = event.context;
    await api.documents.create(spaceId, {
      title: "Welcome",
      body: `<div>
        <h1>Welcome!</h1>
        <h2>To get started, follow these steps:</h2>
        <h2>1. Step One</h2>
        <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.</p>
        <h3>Remember, if you need any assistance, you can always refer back to this page by clicking "Welcome" in the left-hand sidebar!</h3>
        </div>`,
    });
    await tick(80, "Document created");
  };

  listener.use(
    configureSpaceWithYamlSchema(
      [
        {
          sourceUrl:
            "https://raw.githubusercontent.com/FlatFilers/flatfile-docs-kitchen-sink/main/typescript/fetch-schemas/example-schemas/yaml/person.yml",
          name: "Custom Person Sheet Name",
          actions: sheetActions,
        },
        {
          sourceUrl:
            "https://raw.githubusercontent.com/FlatFilers/flatfile-docs-kitchen-sink/main/typescript/fetch-schemas/example-schemas/yaml/product.yml",
        },
      ] as ModelToSheetConfig[],
      {
        workbookConfig: {
          name: "Custom YAML Schema Workbook Name",
          actions: workbookActions,
        } as PartialWorkbookConfig,
        debug: true,
      },
      callback
    )
  );
}

Closes: No associated Issue or Track.

[madaley1]

Want to put a note here, the failing tests are due to the zip-extractor plugin, I'll probably figure out what's wrong with it in another PR.

Edit: Tests passing locally, not sure why they're failing here

[madaley1]

After rerunning the tests in debug they're passing. I wonder if it's something with async timing since the tests are somewhat slower when debug is enabled?

[madaley1]

After some more review, I realized I jumped the gun when I removed the code from JSON schema, so this last commit undoes those changes. I feel it is best to keep JSON Schema unchanged and add the DRYed up YAML code, and then DRY up the JSON schema in a separate PR. LMK if there's a better way to do this!

[carlbrugger]

After some more review, I realized I jumped the gun when I removed the code from JSON schema, so this last commit undoes those changes. I feel it is best to keep JSON Schema unchanged and add the DRYed up YAML code, and then DRY up the JSON schema in a separate PR. LMK if there's a better way to do this!

I agree!

[socket-security]

New and updated dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@flatfile/plugin-json-schema	0.0.2	None	+0	872 B	flatfileinfra
axios	1.6.0...1.6.1	None	+0/-0	1.8 MB	jasonsaayman

[madaley1]

After troubleshooting this for a bit, I have realized that the reason it's failing was because this was built around the changes to JSON-schema I reverted. I was able to patch around it, but it'll take some refactoring after release when we transition json-schema to DRY it up overall.

[madaley1]

Also I had to revert one of the JSON -> YAML corrections due to how the plugin uses the JSON-schema plugin and it using the default defined in JSON-Schema and it's not redefined anywhere in YAML-Schema

[carlbrugger]

lgtm