update exporter in ai

Author: alexspevak

packages/octopus-ai/src/entities/source/source-design.ts

@@ -3,8 +3,9 @@ import { uniqueIdFactory } from '@opendesign/octopus-common/dist/utils/common.js
 import { SourceArtboard } from './source-artboard.js'
 
 import type { Metadata } from '../../services/readers/ai-file-reader-common.js'
-import type { SourceImage, SourceTree } from '../../typings/index.js'
+import type { SourceTree } from '../../typings/index.js'
 import type { AdditionalTextData } from '../../typings/raw/index.js'
+import type { SourceImage } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
 import type { Nullish } from '@opendesign/octopus-common/dist/utility-types.js'
 
 export class SourceDesign {

packages/octopus-ai/src/services/conversion/design-converter/index.ts

@@ -11,11 +11,11 @@ import { TextLayerGroupingservice } from '../text-layer-grouping-service/index.j
 import type { SourceArtboard } from '../../../entities/source/source-artboard.js'
 import type { SourceDesign } from '../../../entities/source/source-design.js'
 import type { OctopusAIConverter } from '../../../octopus-ai-converter.js'
-import type { SourceImage } from '../../../typings/index.js'
 import type { Manifest } from '../../../typings/manifest/index.js'
 import type { Octopus } from '../../../typings/octopus/index.js'
 import type { AdditionalTextData } from '../../../typings/raw/index.js'
 import type { Exporter } from '../exporters/index.js'
+import type { SourceImage } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
 import type { SafeResult } from '@opendesign/octopus-common/dist/utils/queue.js'
 
 type DesignConverterGeneralOptions = {
@@ -133,8 +133,7 @@ export class DesignConverter {
     const images = await Promise.all(
       artboardImages.map(async (image) => {
         const imageId = image.id
-        const rawData = await image.getImageData()
-        const imagePath = (await rejectTo(exporter?.exportImage?.(image.id, rawData) ?? Promise.reject(''))) as string
+        const imagePath = (await rejectTo(exporter?.exportImage?.(image) ?? Promise.reject(''))) as string
         this.manifest.setExportedImage(imageId, imagePath)
 
         return image

packages/octopus-ai/src/services/conversion/design-converter/test/index.test.ts

@@ -101,9 +101,9 @@ describe('DesignConverter', () => {
 
       const sourceDesign = {
         images: [
-          { id: 'image-1.jpg', path: 'path/image-1.jpg', getImageData: async () => 'base64;image-1' },
-          { id: 'image-2.jpg', path: 'path/image-1.jpg', getImageData: async () => 'base64;image-2' },
-          { id: 'image-3.jpg', path: 'path/image-3.jpg', getImageData: async () => 'base64;image-3' },
+          { id: 'image-1.jpg', getImageData: async () => 'base64;image-1' },
+          { id: 'image-2.jpg', getImageData: async () => 'base64;image-2' },
+          { id: 'image-3.jpg', getImageData: async () => 'base64;image-3' },
         ],
       }
 
@@ -113,7 +113,7 @@ describe('DesignConverter', () => {
         .mockReturnValueOnce({ id: 1, value: { id: '1' }, error: null, time: 5 })
 
       const exporter: any = {
-        exportImage: vi.fn().mockImplementation(async (imagePath) => 'root/' + imagePath),
+        exportImage: vi.fn().mockImplementation(async (image) => 'root/' + image.id),
         exportArtboard: vi.fn().mockImplementation(async (artboard) => 'root/' + artboard.value.id),
       }
 
@@ -132,8 +132,15 @@ describe('DesignConverter', () => {
         images: [sourceDesign.images[0], sourceDesign.images[2]],
       })
 
-      expect(exporter.exportImage).toHaveBeenCalledWith('image-1.jpg', 'base64;image-1')
-      expect(exporter.exportImage).toHaveBeenCalledWith('image-3.jpg', 'base64;image-3')
+      expect(exporter.exportImage).toHaveBeenCalledWith({
+        getImageData: expect.any(Function),
+        id: 'image-1.jpg',
+      })
+
+      expect(exporter.exportImage).toHaveBeenCalledWith({
+        getImageData: expect.any(Function),
+        id: 'image-3.jpg',
+      })
 
       expect(manifestInstanceMock.setExportedImage).toHaveBeenCalledWith('image-1.jpg', 'root/image-1.jpg')
       expect(manifestInstanceMock.setExportedImage).toHaveBeenCalledWith('image-3.jpg', 'root/image-3.jpg')

packages/octopus-ai/src/services/conversion/exporters/index.ts

@@ -1,14 +1,39 @@
 import type { SourceArtboard } from '../../../entities/source/source-artboard.js'
 import type { SourceDesign } from '../../../entities/source/source-design.js'
 import type { ArtboardConversionResult, DesignConversionResult } from '../design-converter/index.js'
+import type { SourceImage } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
 
 export type AuxiliaryData = { metadata: string; additionalTextData: string | null }
 
-export interface Exporter {
-  exportAuxiliaryData?(_design: SourceDesign): Promise<AuxiliaryData>
-  exportImage?(_path: string, _data: Uint8Array): Promise<unknown>
-  exportArtboard?(_source: SourceArtboard, _artboard: ArtboardConversionResult): Promise<unknown>
-  exportManifest?(_manifest: DesignConversionResult): Promise<unknown>
-  getBasePath(): Promise<string>
-  finalizeExport(): void
+export abstract class Exporter {
+  exportImage(image: SourceImage): Promise<unknown> {
+    const { id } = image
+    console.log('calling default export method `exportImage()`')
+    return Promise.resolve(id)
+  }
+
+  finalizeExport(): void {
+    console.log('calling default export method `finalizeExport()`')
+    Promise.resolve()
+  }
+
+  exportArtboard(_source: SourceArtboard, _artboard: ArtboardConversionResult): Promise<unknown> {
+    console.log('calling default export method `exportArtboard()`')
+    return Promise.resolve()
+  }
+
+  exportManifest(_manifest: DesignConversionResult): Promise<unknown> {
+    console.log('calling default export method `exportManifest()`')
+    return Promise.resolve()
+  }
+
+  exportAuxiliaryData(_design: SourceDesign): Promise<AuxiliaryData> {
+    console.log('calling default export method `exportAuxiliaryData()`')
+    return Promise.resolve({ metadata: '', additionalTextData: null })
+  }
+
+  getBasePath(): Promise<string> {
+    console.log('calling default export method `getBasePath()`')
+    return Promise.resolve('')
+  }
 }

packages/octopus-ai/src/services/conversion/exporters/local-exporter.ts

@@ -11,6 +11,7 @@ import type { Exporter, AuxiliaryData } from './index.js'
 import type { SourceArtboard } from '../../../entities/source/source-artboard.js'
 import type { SourceDesign } from '../../../entities/source/source-design.js'
 import type { ArtboardConversionResult, DesignConversionResult } from '../design-converter/index.js'
+import type { SourceImage } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
 import type { DetachedPromiseControls } from '@opendesign/octopus-common/dist/utils/async.js'
 
 type LocalExporterOptions = {
@@ -103,12 +104,12 @@ export class LocalExporter implements Exporter {
 
   /**
    * Exports given Image into folder specified in `LocalExporter.IMAGES_DIR_NAME`
-   * @param {string} name Name of the exported Image
-   * @param {Buffer} data Data representation of given image
+   * @param {SourceImage} with signature {id:string, getImageData: () => Promise<Uint8Array>}
    * @returns {Promise<string>} which designates path to the exported Image
    */
-  exportImage(name: string, data: Buffer): Promise<string> {
-    return this._save(path.join(LocalExporter.IMAGES_DIR_NAME, path.basename(name)), data)
+  async exportImage(image: SourceImage): Promise<string> {
+    const data = await image.getImageData()
+    return this._save(path.join(LocalExporter.IMAGES_DIR_NAME, path.basename(image.id)), Buffer.from(data))
   }
 
   finalizeExport(): void {

packages/octopus-ai/src/services/conversion/exporters/temp-exporter.ts

@@ -11,6 +11,7 @@ import type { Exporter, AuxiliaryData } from './index.js'
 import type { SourceArtboard } from '../../../entities/source/source-artboard.js'
 import type { SourceDesign } from '../../../entities/source/source-design.js'
 import type { ArtboardConversionResult, DesignConversionResult } from '../design-converter/index.js'
+import type { SourceImage } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
 import type { DetachedPromiseControls } from '@opendesign/octopus-common/dist/utils/async.js'
 
 type TempExporterOptions = {
@@ -26,6 +27,7 @@ type TempExporterOptions = {
 /**
  * Exporter created to be used in manual runs.
  */
+
 export class TempExporter extends EventEmitter implements Exporter {
   private _outputDir: Promise<string>
   private _tempDir: string
@@ -132,8 +134,9 @@ export class TempExporter extends EventEmitter implements Exporter {
    * @param {Buffer} data Data representation of given image
    * @returns {Promise<string>} which designates path to the exported Image
    */
-  async exportImage(name: string, data: Buffer): Promise<string> {
-    return this._save(path.join(TempExporter.IMAGES_DIR_NAME, path.basename(name)), data)
+  async exportImage(image: SourceImage): Promise<string> {
+    const data = await image.getImageData()
+    return this._save(path.join(TempExporter.IMAGES_DIR_NAME, path.basename(image.id)), Buffer.from(data))
   }
 
   finalizeExport(): void {

packages/octopus-ai/src/services/conversion/exporters/web-exporter.ts

@@ -1,35 +1,6 @@
-import type { AuxiliaryData } from './index.js'
-import type { SourceArtboard } from '../../../entities/source/source-artboard.js'
-import type { SourceDesign } from '../../../octopus-ai-converter.js'
-import type { ArtboardConversionResult, DesignConversionResult } from '../design-converter/index.js'
+import { Exporter } from './index.js'
 
 /**
  * Minimalistic exporter used for web build
  */
-export class WebExporter {
-  exportImage(name: string, _data: Uint8Array): Promise<unknown> {
-    return Promise.resolve(name)
-  }
-
-  getBasePath(): Promise<string> {
-    return Promise.resolve('')
-  }
-
-  finalizeExport(): void {
-    Promise.resolve()
-  }
-  exportArtboard(_source: SourceArtboard, _artboard: ArtboardConversionResult): Promise<unknown> {
-    console.log('Exporting artboard')
-    return Promise.resolve()
-  }
-
-  exportManifest(_manifest: DesignConversionResult): Promise<unknown> {
-    console.log('Exporting manifest')
-    return Promise.resolve()
-  }
-
-  exportAuxiliaryData(_design: SourceDesign): Promise<AuxiliaryData> {
-    console.log('Exporting auxiliary data')
-    return Promise.resolve({ metadata: '', additionalTextData: null })
-  }
-}
+export class WebExporter extends Exporter {}

packages/octopus-ai/src/services/readers/ai-file-reader-common.ts

@@ -1,8 +1,8 @@
 import { SourceDesign } from '../../entities/source/source-design.js'
 
-import type { SourceImage, SourceTree } from '../../typings/index.js'
+import type { SourceTree } from '../../typings/index.js'
 import type { AdditionalTextData, RawArtboardEntry } from '../../typings/raw/index.js'
-import type { DesignMeta } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
+import type { DesignMeta, SourceImage } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
 
 export type Metadata = {
   version: string

packages/octopus-ai/src/services/readers/node/index.ts

@@ -8,9 +8,9 @@ import { v4 as uuidv4 } from 'uuid'
 
 import { AIFileReaderCommon } from '../ai-file-reader-common.js'
 
-import type { SourceImage } from '../../../typings/index.js'
 import type { AdditionalTextData, RawArtboardEntry } from '../../../typings/raw/index.js'
 import type { FsContext } from '@opendesign/illustrator-parser-pdfcpu/fs_context'
+import type { SourceImage } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
 
 type AIFileReaderOptions = {
   /** Path to the .ai file. */

packages/octopus-ai/src/services/readers/node/test/index.test.ts

@@ -24,15 +24,15 @@ describe('AIFileReader', () => {
       const privateDataMock = Promise.resolve({ Textlayers: [], LayerNames: [] })
       vi.mocked(FSContext).mockResolvedValueOnce(ctxMock)
       vi.mocked(ArtBoardRefs).mockReturnValueOnce([{ idx: 1 }, { idx: 2 }] as any)
-      vi.mocked(ArtBoard).mockImplementation(async (_, ref) => ({ id: `${ref.idx}` } as any))
+      vi.mocked(ArtBoard).mockImplementation(async (_, ref) => ({ Id: ref.idx } as any))
       vi.mocked(PrivateData).mockResolvedValueOnce(await privateDataMock)
 
       const result = await AIFileReader.prototype['_getSourceData']()
 
       expect(mkdir).toHaveBeenCalledWith('root/path', { recursive: true })
       expect(result).toEqual({
         additionalTextData: { LayerNames: [], Textlayers: [] },
-        artboards: [{ id: '1' }, { id: '2' }],
+        artboards: [{ Id: 1 }, { Id: 2 }],
         metadata: { version: '1.0.1' },
       })
       expect(AIFileReader.prototype['_images']).toEqual(ctxMock.Bitmaps)

packages/octopus-ai/src/services/readers/web/index.ts

@@ -3,9 +3,9 @@ import { WASMContext } from '@opendesign/illustrator-parser-pdfcpu/wasm_context'
 
 import { AIFileReaderCommon } from '../ai-file-reader-common.js'
 
-import type { SourceImage } from '../../../typings/index.js'
 import type { AdditionalTextData, RawArtboardEntry } from '../../../typings/raw/index.js'
 import type { BitmapReader, WasmContext } from '@opendesign/illustrator-parser-pdfcpu/wasm_context'
+import type { SourceImage } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
 
 type AIFileReaderOptions = {
   /** Uint8Array representation of converted .ai file */

packages/octopus-ai/src/typings/index.ts

@@ -2,6 +2,7 @@
 
 import type { AdditionalTextData, RawArtboardEntry } from './raw/index.js'
 import type { Metadata } from '../services/readers/ai-file-reader-common.js'
+import type { SourceImage } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
 
 export interface Logger {
   fatal: Function
@@ -25,8 +26,6 @@ export type GradientStop = {
 
 export type Color = { r: number; g: number; b: number; a: number }
 
-export type SourceImage = { id: string; getImageData: () => Promise<Uint8Array> }
-
 export type SourceTree = {
   metadata: Metadata
   images: SourceImage[]

packages/octopus-common/src/typings/octopus-common/index.ts

@@ -1,11 +1,10 @@
 import type { Octopus as OctopusRaw } from '@opendesign/octopus-ts'
 
 export type Octopus = OctopusRaw['schemas']
-
 export type ComponentMeta = { id: string; name: string; role: 'ARTBOARD' | 'COMPONENT' }
 export type PageMeta = { id: string; name: string; children: ComponentMeta[] }
 export type Origin = { name: 'FIGMA' | 'ILLUSTRATOR' | 'XD' | 'PHOTOSHOP'; version: string }
-
+export type SourceImage = { id: string; getImageData: () => Promise<Uint8Array> }
 export type DesignMeta = {
   pages: PageMeta[]
   components: ComponentMeta[]

packages/octopus-psd/src/services/exporters/local-exporter.ts

@@ -10,6 +10,7 @@ import { stringify } from '../../utils/stringify.js'
 
 import type { AbstractExporter } from './abstract-exporter.js'
 import type { ComponentConversionResult, DesignConversionResult } from '../conversion/design-converter.js'
+import type { SourceImage } from '@opendesign/octopus-common/dist/typings/octopus-common/index.js'
 import type { DetachedPromiseControls } from '@opendesign/octopus-common/dist/utils/async.js'
 
 export type LocalExporterOptions = {
@@ -85,8 +86,10 @@ export class LocalExporter implements AbstractExporter {
    * @param {Uint8Array} data image data
    * @returns {Promise<string>} returns path to the exported Image
    */
-  async exportImage(name: string, data: Uint8Array): Promise<string> {
-    return this._save(path.join(LocalExporter.IMAGES_DIR_NAME, path.basename(name)), Buffer.from(data))
+  async exportImage(image: SourceImage): Promise<string> {
+    const { id } = image
+    const data = await image.getImageData()
+    return this._save(path.join(LocalExporter.IMAGES_DIR_NAME, path.basename(id)), Buffer.from(data))
   }
 
   /**