diff --git a/packages/chrome-extension/src/app/components/common/ChromeResourceContentService.ts b/packages/chrome-extension/src/app/components/common/ChromeResourceContentService.ts index 064dd27e7fb..1343dd85a2a 100644 --- a/packages/chrome-extension/src/app/components/common/ChromeResourceContentService.ts +++ b/packages/chrome-extension/src/app/components/common/ChromeResourceContentService.ts @@ -44,7 +44,7 @@ class ChromeResourceContentService implements ResourceContentService { normalizedPosixPathRelativeToTheWorkspaceRoot: string, opts?: ResourceContentOptions ): Promise { - opts = opts ?? { type: ContentType.TEXT }; + opts = opts ?? { type: "text" }; return fetchFile( this.octokit, this.repoInfo.owner, diff --git a/packages/chrome-extension/src/app/github/api.ts b/packages/chrome-extension/src/app/github/api.ts index 0e86f6ed414..c33a673f0e3 100644 --- a/packages/chrome-extension/src/app/github/api.ts +++ b/packages/chrome-extension/src/app/github/api.ts @@ -35,7 +35,7 @@ export function fetchFile( ref: ref, path: path, }) - .then((res) => (contentType === ContentType.BINARY ? (res.data as any).content : atob((res.data as any).content))) + .then((res) => (contentType === "binary" ? (res.data as any).content : atob((res.data as any).content))) .catch((e) => { console.debug(`Error fetching ${path} with Octokit. Fallback is 'raw.githubusercontent.com'.`); return fetch(`https://raw.githubusercontent.com/${org}/${repo}/${ref}/${path}`).then((res) => diff --git a/packages/dmn-editor-envelope/src/DmnEditorRoot.tsx b/packages/dmn-editor-envelope/src/DmnEditorRoot.tsx index c6741d3cc3c..608d6d77d42 100644 --- a/packages/dmn-editor-envelope/src/DmnEditorRoot.tsx +++ b/packages/dmn-editor-envelope/src/DmnEditorRoot.tsx @@ -267,7 +267,7 @@ export class DmnEditorRoot extends React.Component; + resources: Array<[string, DmnEditorStandaloneResource]>; origin: string; }; diff --git a/packages/dmn-editor-standalone/tests-e2e/__fixtures__/editor.ts b/packages/dmn-editor-standalone/tests-e2e/__fixtures__/editor.ts index 5ecc57ef09d..c030c6e9858 100644 --- a/packages/dmn-editor-standalone/tests-e2e/__fixtures__/editor.ts +++ b/packages/dmn-editor-standalone/tests-e2e/__fixtures__/editor.ts @@ -18,7 +18,6 @@ */ import { Page, expect } from "@playwright/test"; -import { ContentType } from "@kie-tools-core/workspace/dist/api"; import type { open, DmnEditorStandaloneApi } from "@kie-tools/dmn-editor-standalone/dist"; import * as prettier from "prettier"; @@ -40,7 +39,7 @@ export class Editor { constructor(public page: Page) {} public async open(args?: { - resources?: Array<[string, { contentType: ContentType; content: string }]>; + resources?: Array<[string, { contentType: "text" | "binary"; content: string }]>; initialFileNormalizedPosixPathRelativeToTheWorkspaceRoot?: string; }) { await this.page.goto(""); diff --git a/packages/dmn-editor-standalone/tests-e2e/includedModels/includedModels.spec.ts b/packages/dmn-editor-standalone/tests-e2e/includedModels/includedModels.spec.ts index f3bf3aedecb..fc8f18b8c0d 100644 --- a/packages/dmn-editor-standalone/tests-e2e/includedModels/includedModels.spec.ts +++ b/packages/dmn-editor-standalone/tests-e2e/includedModels/includedModels.spec.ts @@ -18,27 +18,20 @@ */ import { test, expect } from "../__fixtures__/base"; -import { ContentType } from "@kie-tools-core/workspace/dist/api"; import { ExternalFile } from "../__fixtures__/files"; test.describe("DMN Editor - Standalone - Resources", () => { test.describe("includedModels/resources", () => { test("should list all resources", async ({ editor, files }) => { - const resources: Array<[string, { contentType: ContentType; content: string }]> = [ + const resources: Array<[string, { contentType: "text" | "binary"; content: string }]> = [ [ "loan-pre-qualification.dmn", - { content: await files.getFile(ExternalFile.LOAN_PRE_QUALIFICATION_DMN), contentType: ContentType.TEXT }, - ], - ["can-drive.dmn", { content: await files.getFile(ExternalFile.CAN_DRIVE_DMN), contentType: ContentType.TEXT }], - [ - "find-employees.dmn", - { content: await files.getFile(ExternalFile.FIND_EMPLOYEES_DMN), contentType: ContentType.TEXT }, - ], - ["types.dmn", { content: await files.getFile(ExternalFile.TYPES_DMN), contentType: ContentType.TEXT }], - [ - "scorecard.pmml", - { content: await files.getFile(ExternalFile.SCORECARD_PMML), contentType: ContentType.TEXT }, + { content: await files.getFile(ExternalFile.LOAN_PRE_QUALIFICATION_DMN), contentType: "text" }, ], + ["can-drive.dmn", { content: await files.getFile(ExternalFile.CAN_DRIVE_DMN), contentType: "text" }], + ["find-employees.dmn", { content: await files.getFile(ExternalFile.FIND_EMPLOYEES_DMN), contentType: "text" }], + ["types.dmn", { content: await files.getFile(ExternalFile.TYPES_DMN), contentType: "text" }], + ["scorecard.pmml", { content: await files.getFile(ExternalFile.SCORECARD_PMML), contentType: "text" }], ]; // Open the editor @@ -61,23 +54,20 @@ test.describe("DMN Editor - Standalone - Resources", () => { }); test("should not list any models to be included", async ({ editor, files }) => { - const resources: Array<[string, { contentType: ContentType; content: string }]> = [ + const resources: Array<[string, { contentType: "text" | "binary"; content: string }]> = [ [ "loan-pre-qualification.dmn", - { content: await files.getFile(ExternalFile.LOAN_PRE_QUALIFICATION_DMN), contentType: ContentType.TEXT }, - ], - [ - "path1/can-drive.dmn", - { content: await files.getFile(ExternalFile.CAN_DRIVE_DMN), contentType: ContentType.TEXT }, + { content: await files.getFile(ExternalFile.LOAN_PRE_QUALIFICATION_DMN), contentType: "text" }, ], + ["path1/can-drive.dmn", { content: await files.getFile(ExternalFile.CAN_DRIVE_DMN), contentType: "text" }], [ "path2/find-employees.dmn", - { content: await files.getFile(ExternalFile.FIND_EMPLOYEES_DMN), contentType: ContentType.TEXT }, + { content: await files.getFile(ExternalFile.FIND_EMPLOYEES_DMN), contentType: "text" }, ], - ["path3/types.dmn", { content: await files.getFile(ExternalFile.TYPES_DMN), contentType: ContentType.TEXT }], + ["path3/types.dmn", { content: await files.getFile(ExternalFile.TYPES_DMN), contentType: "text" }], [ "path1/pmml/scorecard.pmml", - { content: await files.getFile(ExternalFile.SCORECARD_PMML), contentType: ContentType.TEXT }, + { content: await files.getFile(ExternalFile.SCORECARD_PMML), contentType: "text" }, ], ]; @@ -94,26 +84,20 @@ test.describe("DMN Editor - Standalone - Resources", () => { }); test("should list all resources on same parent path", async ({ editor, files }) => { - const resources: Array<[string, { contentType: ContentType; content: string }]> = [ + const resources: Array<[string, { contentType: "text" | "binary"; content: string }]> = [ [ "loan-pre-qualification.dmn", - { content: await files.getFile(ExternalFile.LOAN_PRE_QUALIFICATION_DMN), contentType: ContentType.TEXT }, - ], - [ - "path1/can-drive.dmn", - { content: await files.getFile(ExternalFile.CAN_DRIVE_DMN), contentType: ContentType.TEXT }, + { content: await files.getFile(ExternalFile.LOAN_PRE_QUALIFICATION_DMN), contentType: "text" }, ], + ["path1/can-drive.dmn", { content: await files.getFile(ExternalFile.CAN_DRIVE_DMN), contentType: "text" }], [ "path2/find-employees.dmn", - { content: await files.getFile(ExternalFile.FIND_EMPLOYEES_DMN), contentType: ContentType.TEXT }, - ], - [ - "path3/types/types.dmn", - { content: await files.getFile(ExternalFile.TYPES_DMN), contentType: ContentType.TEXT }, + { content: await files.getFile(ExternalFile.FIND_EMPLOYEES_DMN), contentType: "text" }, ], + ["path3/types/types.dmn", { content: await files.getFile(ExternalFile.TYPES_DMN), contentType: "text" }], [ "path1/pmml/scorecard.pmml", - { content: await files.getFile(ExternalFile.SCORECARD_PMML), contentType: ContentType.TEXT }, + { content: await files.getFile(ExternalFile.SCORECARD_PMML), contentType: "text" }, ], ]; diff --git a/packages/kie-editors-standalone/e2e-tests/src/App.tsx b/packages/kie-editors-standalone/e2e-tests/src/App.tsx index c5ea5bbbd37..71842913f0b 100644 --- a/packages/kie-editors-standalone/e2e-tests/src/App.tsx +++ b/packages/kie-editors-standalone/e2e-tests/src/App.tsx @@ -105,7 +105,7 @@ export function App() { [ "custom-workitem.wid", { - contentType: ContentType.TEXT, + contentType: "text", content: Promise.resolve(customWorkItemWid), }, ], diff --git a/packages/kie-editors-standalone/e2e-tests/src/components/EditorComponent.tsx b/packages/kie-editors-standalone/e2e-tests/src/components/EditorComponent.tsx index 4043fa770b1..c989acab620 100644 --- a/packages/kie-editors-standalone/e2e-tests/src/components/EditorComponent.tsx +++ b/packages/kie-editors-standalone/e2e-tests/src/components/EditorComponent.tsx @@ -93,7 +93,7 @@ export const EditorComponent = ({ name: modelName, value: { normalizedPosixPathRelativeToTheWorkspaceRoot: modelName, - type: ContentType.TEXT, + type: "text", content, }, }, diff --git a/packages/kie-editors-standalone/e2e-tests/src/components/FileLoader.tsx b/packages/kie-editors-standalone/e2e-tests/src/components/FileLoader.tsx index fc039ad12f5..1ca33e984c0 100644 --- a/packages/kie-editors-standalone/e2e-tests/src/components/FileLoader.tsx +++ b/packages/kie-editors-standalone/e2e-tests/src/components/FileLoader.tsx @@ -50,7 +50,7 @@ export const FileLoader: React.FC = (props: Props) => { name: file.name, value: { normalizedPosixPathRelativeToTheWorkspaceRoot: file.name, - type: ContentType.TEXT, + type: "text", content: fileContent, }, }, diff --git a/packages/kie-editors-standalone/src/bpmn/index.ts b/packages/kie-editors-standalone/src/bpmn/index.ts index b84c85ee439..412d633f1ed 100644 --- a/packages/kie-editors-standalone/src/bpmn/index.ts +++ b/packages/kie-editors-standalone/src/bpmn/index.ts @@ -29,8 +29,7 @@ import { } from "@kie-tools-core/editor/dist/api"; import { StandaloneEditorsEditorChannelApiImpl } from "../envelope/StandaloneEditorsEditorChannelApiImpl"; import { StateControl } from "@kie-tools-core/editor/dist/channel"; -import { ContentType } from "@kie-tools-core/workspace/dist/api"; -import { createEditor, Editor, StandaloneEditorApi } from "../common/Editor"; +import { createEditor, Editor, EditorStandaloneResource, StandaloneEditorApi } from "../common/Editor"; import { BpmnEditorDiagramApi } from "../jsdiagram/BpmnEditorDiagramApi"; import { BpmnEditorEnvelopeApi } from "@kie-tools/kie-bc-editors/dist/bpmn/api"; @@ -71,7 +70,7 @@ export function open(args: { readOnly?: boolean; origin?: string; onError?: () => any; - resources?: Map }>; + resources?: Map; }): StandaloneEditorApi & BpmnEditorDiagramApi { const iframe = document.createElement("iframe"); iframe.srcdoc = bpmnEnvelopeIndex; diff --git a/packages/kie-editors-standalone/src/common/Editor.ts b/packages/kie-editors-standalone/src/common/Editor.ts index e97d4cde678..620d0db70f8 100644 --- a/packages/kie-editors-standalone/src/common/Editor.ts +++ b/packages/kie-editors-standalone/src/common/Editor.ts @@ -17,7 +17,6 @@ * under the License. */ -import { ContentType } from "@kie-tools-core/workspace/dist/api"; import { EditorApi, KogitoEditorEnvelopeApi } from "@kie-tools-core/editor/dist/api"; import { StateControl } from "@kie-tools-core/editor/dist/channel"; import { MessageBusClientApi } from "@kie-tools-core/envelope-bus/dist/api"; @@ -30,13 +29,15 @@ export interface StandaloneEditorApi extends EditorApi { close: () => void; } +export type EditorStandaloneResource = { contentType: "text" | "binary"; content: Promise }; + export interface Editor { open: (args: { container: Element; initialContent: Promise; readOnly: boolean; origin?: string; - resources?: Map }>; + resources?: Map; }) => StandaloneEditorApi; } diff --git a/packages/kie-editors-standalone/src/dmn/index.ts b/packages/kie-editors-standalone/src/dmn/index.ts index 0c670864f29..1da0066d4f1 100644 --- a/packages/kie-editors-standalone/src/dmn/index.ts +++ b/packages/kie-editors-standalone/src/dmn/index.ts @@ -29,8 +29,7 @@ import { } from "@kie-tools-core/editor/dist/api"; import { StandaloneEditorsEditorChannelApiImpl } from "../envelope/StandaloneEditorsEditorChannelApiImpl"; import { StateControl } from "@kie-tools-core/editor/dist/channel"; -import { ContentType } from "@kie-tools-core/workspace/dist/api"; -import { createEditor, Editor, StandaloneEditorApi } from "../common/Editor"; +import { createEditor, Editor, EditorStandaloneResource, StandaloneEditorApi } from "../common/Editor"; import { DmnEditorDiagramApi } from "../jsdiagram/DmnEditorDiagramApi"; import { DmnEditorEnvelopeApi } from "@kie-tools/kie-bc-editors/dist/dmn/api"; @@ -71,7 +70,7 @@ export function open(args: { readOnly?: boolean; origin?: string; onError?: () => any; - resources?: Map }>; + resources?: Map; }): StandaloneEditorApi & DmnEditorDiagramApi { const iframe = document.createElement("iframe"); iframe.srcdoc = dmnEnvelopeIndex; diff --git a/packages/kie-editors-standalone/src/envelope/StandaloneEditorsEditorChannelApiImpl.ts b/packages/kie-editors-standalone/src/envelope/StandaloneEditorsEditorChannelApiImpl.ts index 6f870e011fc..c85c703b52d 100644 --- a/packages/kie-editors-standalone/src/envelope/StandaloneEditorsEditorChannelApiImpl.ts +++ b/packages/kie-editors-standalone/src/envelope/StandaloneEditorsEditorChannelApiImpl.ts @@ -18,12 +18,12 @@ */ import { - ContentType, WorkspaceEdit, ResourceContent, ResourceContentRequest, ResourceListRequest, ResourcesList, + ContentType, } from "@kie-tools-core/workspace/dist/api"; import { EditorContent, @@ -34,6 +34,7 @@ import { import { EmbeddedEditorFile, StateControl } from "@kie-tools-core/editor/dist/channel"; import { Minimatch } from "minimatch"; import { Notification } from "@kie-tools-core/notifications/dist/api"; +import { EditorStandaloneResource } from "../common/Editor"; export class StandaloneEditorsEditorChannelApiImpl implements KogitoEditorChannelApi { constructor( @@ -43,7 +44,7 @@ export class StandaloneEditorsEditorChannelApiImpl implements KogitoEditorChanne private readonly overrides: Partial, private readonly resources?: Map< string /** normalized posix path relative to the "workspace" root */, - { contentType: ContentType; content: Promise } + EditorStandaloneResource > ) {} diff --git a/packages/vscode-extension/src/workspace/VsCodeResourceContentServiceForDanglingFiles.ts b/packages/vscode-extension/src/workspace/VsCodeResourceContentServiceForDanglingFiles.ts index 2ac08977e2c..1e21bd24503 100644 --- a/packages/vscode-extension/src/workspace/VsCodeResourceContentServiceForDanglingFiles.ts +++ b/packages/vscode-extension/src/workspace/VsCodeResourceContentServiceForDanglingFiles.ts @@ -85,17 +85,17 @@ export class VsCodeResourceContentServiceForDanglingFiles implements ResourceCon try { const content = await vscode.workspace.fs.readFile(vscode.Uri.file(absoluteFsPath)); - if (opts?.type === ContentType.BINARY) { + if (opts?.type === "binary") { return new ResourceContent( normalizedPosixPathRelativeToTheWorkspaceRoot, // Always return the relative path. Buffer.from(content).toString("base64"), - ContentType.BINARY + "binary" ); } else { return new ResourceContent( normalizedPosixPathRelativeToTheWorkspaceRoot, // Always return the relative path. Buffer.from(content).toString(), - ContentType.TEXT + "text" ); } } catch (e) { diff --git a/packages/vscode-extension/src/workspace/VsCodeResourceContentServiceForWorkspaces.ts b/packages/vscode-extension/src/workspace/VsCodeResourceContentServiceForWorkspaces.ts index 99dce8df863..e05423b23c6 100644 --- a/packages/vscode-extension/src/workspace/VsCodeResourceContentServiceForWorkspaces.ts +++ b/packages/vscode-extension/src/workspace/VsCodeResourceContentServiceForWorkspaces.ts @@ -149,17 +149,17 @@ Resolved path: ${__path.resolve(workspaceRootAbsoluteFsPath, normalizedFsPathRel try { const content = await vscode.workspace.fs.readFile(vscode.Uri.file(absoluteFsPath)); - if (opts?.type === ContentType.BINARY) { + if (opts?.type === "binary") { return new ResourceContent( normalizedPosixPathRelativeToTheWorkspaceRoot, // Always return the relative path. Buffer.from(content).toString("base64"), - ContentType.BINARY + "binary" ); } else { return new ResourceContent( normalizedPosixPathRelativeToTheWorkspaceRoot, // Always return the relative path. Buffer.from(content).toString(), - ContentType.TEXT + "text" ); } } catch (e) { diff --git a/packages/vscode-extension/tests/VsCodeResourceContentServiceForDanglingFiles.test.ts b/packages/vscode-extension/tests/VsCodeResourceContentServiceForDanglingFiles.test.ts index 30542095793..b6f90afa2bf 100644 --- a/packages/vscode-extension/tests/VsCodeResourceContentServiceForDanglingFiles.test.ts +++ b/packages/vscode-extension/tests/VsCodeResourceContentServiceForDanglingFiles.test.ts @@ -68,7 +68,7 @@ describe("VsCodeResourceContentServiceForDanglingFiles", () => { expect(resource1Content).not.toBeNull(); expect(resource1Content?.normalizedPosixPathRelativeToTheWorkspaceRoot).toBe(resource1Path); - expect(resource1Content?.type).toBe(ContentType.TEXT); + expect(resource1Content?.type).toBe("text"); expect(resource1Content?.content).toBe("content for resource 1"); const resource2Path = "resource2.txt"; @@ -76,15 +76,15 @@ describe("VsCodeResourceContentServiceForDanglingFiles", () => { expect(resource2Content).not.toBeNull(); expect(resource2Content?.normalizedPosixPathRelativeToTheWorkspaceRoot).toBe(resource2Path); - expect(resource2Content?.type).toBe(ContentType.TEXT); + expect(resource2Content?.type).toBe("text"); expect(resource2Content?.content).toBe("content for resource 2"); const iconPath = "icon.png"; - const iconContent = await resourceContentService.get(iconPath, { type: ContentType.BINARY }); + const iconContent = await resourceContentService.get(iconPath, { type: "binary" }); expect(iconContent).not.toBeNull(); expect(iconContent?.normalizedPosixPathRelativeToTheWorkspaceRoot).toBe(iconPath); - expect(iconContent?.type).toBe(ContentType.BINARY); + expect(iconContent?.type).toBe("binary"); expect(iconContent?.content).not.toBeNull(); }); @@ -98,15 +98,15 @@ describe("VsCodeResourceContentServiceForDanglingFiles", () => { expect(txtResourceContent).not.toBeNull(); expect(txtResourceContent?.normalizedPosixPathRelativeToTheWorkspaceRoot).toBe(txtResourcePath); - expect(txtResourceContent?.type).toBe(ContentType.TEXT); + expect(txtResourceContent?.type).toBe("text"); expect(txtResourceContent?.content).toBe(undefined); const binaryPath = "icon.png"; - const binaryContent = await resourceContentService.get(binaryPath, { type: ContentType.BINARY }); + const binaryContent = await resourceContentService.get(binaryPath, { type: "binary" }); expect(binaryContent).not.toBeNull(); expect(binaryContent?.normalizedPosixPathRelativeToTheWorkspaceRoot).toBe(binaryPath); - expect(binaryContent?.type).toBe(ContentType.BINARY); + expect(binaryContent?.type).toBe("binary"); expect(binaryContent?.content).toBe(undefined); }); }); diff --git a/packages/workspace/src/api/ContentType.ts b/packages/workspace/src/api/ContentType.ts index 6cbbbb0fd02..dd397391ed0 100644 --- a/packages/workspace/src/api/ContentType.ts +++ b/packages/workspace/src/api/ContentType.ts @@ -17,7 +17,4 @@ * under the License. */ -export enum ContentType { - TEXT = "text", - BINARY = "binary", -} +export type ContentType = "text" | "binary"; diff --git a/packages/workspace/src/api/ResourceContent.ts b/packages/workspace/src/api/ResourceContent.ts index d0716baab8b..86c4d28a9a7 100644 --- a/packages/workspace/src/api/ResourceContent.ts +++ b/packages/workspace/src/api/ResourceContent.ts @@ -23,6 +23,6 @@ export class ResourceContent { constructor( public readonly normalizedPosixPathRelativeToTheWorkspaceRoot: string, public readonly content: string | undefined, - public readonly type: ContentType = ContentType.TEXT + public readonly type: ContentType = "text" ) {} } diff --git a/packages/workspaces-git-fs/src/worker/WorkspacesWorkerApiImpl.ts b/packages/workspaces-git-fs/src/worker/WorkspacesWorkerApiImpl.ts index 8d093eb9dee..04d37442a65 100644 --- a/packages/workspaces-git-fs/src/worker/WorkspacesWorkerApiImpl.ts +++ b/packages/workspaces-git-fs/src/worker/WorkspacesWorkerApiImpl.ts @@ -178,12 +178,12 @@ export class WorkspacesWorkerApiImpl implements WorkspacesWorkerApi { return new ResourceContent( args.relativePath, file.content ? Buffer.from(file.content).toString("base64") : "", - ContentType.BINARY + "binary" ); } // "text" is the default - return new ResourceContent(args.relativePath, decoder.decode(file.content), ContentType.TEXT); + return new ResourceContent(args.relativePath, decoder.decode(file.content), "text"); } catch (e) { console.error(e); throw e;