92 lines
3.2 KiB
JavaScript
92 lines
3.2 KiB
JavaScript
|
import { Document } from "@langchain/core/documents";
|
||
|
|
import { getEnvironmentVariable } from "@langchain/core/utils/env";
|
||
|
|
import { BaseDocumentLoader } from "@langchain/core/document_loaders/base";
|
||
|
|
/**
|
||
|
|
* Class representing a document loader for loading Figma files. It
|
||
|
|
* extends the BaseDocumentLoader and implements the FigmaLoaderParams
|
||
|
|
* interface. The constructor takes a config object as a parameter, which
|
||
|
|
* contains the access token, an array of node IDs, and the file key.
|
||
|
|
* @example
|
||
|
|
* ```typescript
|
||
|
|
* const loader = new FigmaFileLoader({
|
||
|
|
* accessToken: "FIGMA_ACCESS_TOKEN",
|
||
|
|
* nodeIds: ["id1", "id2", "id3"],
|
||
|
|
* fileKey: "key",
|
||
|
|
* });
|
||
|
|
* const docs = await loader.load();
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
export class FigmaFileLoader extends BaseDocumentLoader {
|
||
|
|
constructor({ accessToken = getEnvironmentVariable("FIGMA_ACCESS_TOKEN"), nodeIds, fileKey, }) {
|
||
|
|
super();
|
||
|
|
Object.defineProperty(this, "accessToken", {
|
||
|
|
enumerable: true,
|
||
|
|
configurable: true,
|
||
|
|
writable: true,
|
||
|
|
value: void 0
|
||
|
|
});
|
||
|
|
Object.defineProperty(this, "nodeIds", {
|
||
|
|
enumerable: true,
|
||
|
|
configurable: true,
|
||
|
|
writable: true,
|
||
|
|
value: void 0
|
||
|
|
});
|
||
|
|
Object.defineProperty(this, "fileKey", {
|
||
|
|
enumerable: true,
|
||
|
|
configurable: true,
|
||
|
|
writable: true,
|
||
|
|
value: void 0
|
||
|
|
});
|
||
|
|
Object.defineProperty(this, "headers", {
|
||
|
|
enumerable: true,
|
||
|
|
configurable: true,
|
||
|
|
writable: true,
|
||
|
|
value: {}
|
||
|
|
});
|
||
|
|
this.accessToken = accessToken;
|
||
|
|
this.nodeIds = nodeIds;
|
||
|
|
this.fileKey = fileKey;
|
||
|
|
if (this.accessToken) {
|
||
|
|
this.headers = {
|
||
|
|
"x-figma-token": this.accessToken,
|
||
|
|
};
|
||
|
|
}
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Constructs the URL for the Figma API call.
|
||
|
|
* @returns The constructed URL as a string.
|
||
|
|
*/
|
||
|
|
constructFigmaApiURL() {
|
||
|
|
return `https://api.figma.com/v1/files/${this.fileKey}/nodes?ids=${this.nodeIds.join(",")}`;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Fetches the Figma file using the Figma API and returns it as a
|
||
|
|
* FigmaFile object.
|
||
|
|
* @returns A Promise that resolves to a FigmaFile object.
|
||
|
|
*/
|
||
|
|
async getFigmaFile() {
|
||
|
|
const url = this.constructFigmaApiURL();
|
||
|
|
const response = await fetch(url, { headers: this.headers });
|
||
|
|
const data = await response.json();
|
||
|
|
if (!response.ok) {
|
||
|
|
throw new Error(`Unable to get figma file: ${response.status} ${JSON.stringify(data)}`);
|
||
|
|
}
|
||
|
|
if (!data) {
|
||
|
|
throw new Error("Unable to get file");
|
||
|
|
}
|
||
|
|
return data;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Fetches the Figma file using the Figma API, creates a Document instance
|
||
|
|
* with the JSON representation of the file as the page content and the
|
||
|
|
* API URL as the metadata, and returns it.
|
||
|
|
* @returns A Promise that resolves to an array of Document instances.
|
||
|
|
*/
|
||
|
|
async load() {
|
||
|
|
const data = await this.getFigmaFile();
|
||
|
|
const text = JSON.stringify(data);
|
||
|
|
const metadata = { source: this.constructFigmaApiURL() };
|
||
|
|
return [new Document({ pageContent: text, metadata })];
|
||
|
|
}
|
||
|
|
}
|