@jpmorganchase/mosaic-source-figma 0.1.0-beta.59

package/dist/index.d.ts

@@ -0,0 +1,115 @@
+import { z } from 'zod';
+import type { Source } from '@jpmorganchase/mosaic-types';
+import type { FigmaPage } from './types/index.js';
+export declare const schema: z.ZodObject<{
+    schedule: z.ZodOptional<z.ZodObject<{
+        checkIntervalMins: z.ZodNumber;
+        initialDelayMs: z.ZodNumber;
+        retryEnabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        retryDelayMins: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        maxRetries: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        resetOnSuccess: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        checkIntervalMins: number;
+        initialDelayMs: number;
+        retryEnabled: boolean;
+        retryDelayMins: number;
+        maxRetries: number;
+        resetOnSuccess: boolean;
+    }, {
+        checkIntervalMins: number;
+        initialDelayMs: number;
+        retryEnabled?: boolean | undefined;
+        retryDelayMins?: number | undefined;
+        maxRetries?: number | undefined;
+        resetOnSuccess?: boolean | undefined;
+    }>>;
+    proxyEndpoint: z.ZodOptional<z.ZodString>;
+    noProxy: z.ZodOptional<z.ZodEffects<z.ZodAny, RegExp, any>>;
+    requestHeaders: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    prefixDir: z.ZodString;
+    figmaToken: z.ZodString;
+    projects: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        patternPrefix: z.ZodString;
+        meta: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+    }, "strip", z.ZodTypeAny, {
+        id: number;
+        patternPrefix: string;
+        meta: {} & {
+            [k: string]: unknown;
+        };
+    }, {
+        id: number;
+        patternPrefix: string;
+        meta: {} & {
+            [k: string]: unknown;
+        };
+    }>, "many">;
+    endpoints: z.ZodObject<{
+        getFile: z.ZodString;
+        getProject: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        getFile: string;
+        getProject: string;
+    }, {
+        getFile: string;
+        getProject: string;
+    }>;
+    requestTimeout: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    endpoints: {
+        getFile: string;
+        getProject: string;
+    };
+    prefixDir: string;
+    requestTimeout: number;
+    figmaToken: string;
+    projects: {
+        id: number;
+        patternPrefix: string;
+        meta: {} & {
+            [k: string]: unknown;
+        };
+    }[];
+    schedule?: {
+        checkIntervalMins: number;
+        initialDelayMs: number;
+        retryEnabled: boolean;
+        retryDelayMins: number;
+        maxRetries: number;
+        resetOnSuccess: boolean;
+    } | undefined;
+    proxyEndpoint?: string | undefined;
+    noProxy?: RegExp | undefined;
+    requestHeaders?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    endpoints: {
+        getFile: string;
+        getProject: string;
+    };
+    prefixDir: string;
+    figmaToken: string;
+    projects: {
+        id: number;
+        patternPrefix: string;
+        meta: {} & {
+            [k: string]: unknown;
+        };
+    }[];
+    schedule?: {
+        checkIntervalMins: number;
+        initialDelayMs: number;
+        retryEnabled?: boolean | undefined;
+        retryDelayMins?: number | undefined;
+        maxRetries?: number | undefined;
+        resetOnSuccess?: boolean | undefined;
+    } | undefined;
+    proxyEndpoint?: string | undefined;
+    noProxy?: any;
+    requestHeaders?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    requestTimeout?: number | undefined;
+}>;
+export declare type FigmaSourceOptions = z.infer<typeof schema>;
+declare const FigmaSource: Source<FigmaSourceOptions, FigmaPage>;
+export default FigmaSource;

package/dist/index.js

@@ -0,0 +1,91 @@
+import { switchMap } from 'rxjs';
+import { z } from 'zod';
+import deepmerge from 'deepmerge';
+import { validateMosaicSchema } from '@jpmorganchase/mosaic-schemas';
+import { createHttpSource, httpSourceCreatorSchema } from '@jpmorganchase/mosaic-source-http';
+import createFigmaPage from './transformer.js';
+const baseSchema = httpSourceCreatorSchema.omit({
+    endpoints: true,
+    transformerOptions: true // stories is the prop we need for this so no point duplicating it in source config
+});
+export const schema = baseSchema.merge(z.object({
+    prefixDir: z.string(),
+    figmaToken: z.string(),
+    projects: z.array(z.object({
+        id: z.number(),
+        patternPrefix: z.string(),
+        meta: z.object({}).passthrough()
+    })),
+    endpoints: z.object({
+        getFile: z.string().url(),
+        getProject: z.string().url()
+    }),
+    requestTimeout: z.number().default(5000)
+}));
+const FigmaSource = {
+    create(options, sourceConfig) {
+        const parsedOptions = validateMosaicSchema(schema, options);
+        const { endpoints, projects, figmaToken, proxyEndpoint, prefixDir, requestHeaders: requestHeadersParam } = parsedOptions;
+        const projectEndpoints = projects.map(project => endpoints.getProject.replace(':project_id', project.id.toString()));
+        const projectsTransformer = (response, _prefixDir, index) => [response].reduce((allProjectFileUrls, { files }) => {
+            const projectFileUrls = files.reduce((project, { key }) => {
+                const fileUrlAndMetadata = {
+                    fileUrl: endpoints.getFile.replace(':file_id', key),
+                    meta: projects[index].meta
+                };
+                return [...project, fileUrlAndMetadata];
+            }, []);
+            return [...allProjectFileUrls, ...projectFileUrls];
+        }, []);
+        const projectFilesTransformer = (response, _prefixDir, index, transformerOptions) => {
+            const { document: { sharedPluginData } } = response;
+            const { patternPrefix } = projects[index];
+            return Object.keys(sharedPluginData).reduce((figmaPagesResult, patternId) => {
+                if (patternId.indexOf(patternPrefix) === 0) {
+                    /** Figma provided metadata */
+                    const figmaProvidedMetadata = {
+                        data: {
+                            patternId,
+                            ...sharedPluginData[patternId]
+                        }
+                    };
+                    const sourceProvidedMetadata = transformerOptions[index].meta;
+                    const figmaPageMeta = sourceProvidedMetadata
+                        ? deepmerge(figmaProvidedMetadata, sourceProvidedMetadata || {})
+                        : figmaProvidedMetadata;
+                    return [...figmaPagesResult, createFigmaPage(figmaPageMeta, prefixDir)];
+                }
+                return figmaPagesResult;
+            }, []);
+        };
+        const projects$ = createHttpSource({
+            endpoints: projectEndpoints,
+            requestHeaders: {
+                'Content-Type': 'application/json',
+                'X-FIGMA-TOKEN': figmaToken,
+                ...requestHeadersParam
+            },
+            proxyEndpoint,
+            prefixDir,
+            transformer: projectsTransformer
+        }, sourceConfig);
+        const figmaSource$ = projects$.pipe(switchMap(fileUrlAndMetaCollection => {
+            const fileUrls = fileUrlAndMetaCollection.map(item => item.fileUrl);
+            return createHttpSource({
+                endpoints: fileUrls,
+                requestHeaders: {
+                    'Content-Type': 'application/json',
+                    'X-FIGMA-TOKEN': figmaToken,
+                    ...requestHeadersParam
+                },
+                proxyEndpoint,
+                prefixDir,
+                transformer: projectFilesTransformer,
+                transformerOptions: fileUrlAndMetaCollection
+            });
+        }));
+        return figmaSource$;
+    }
+};
+export default FigmaSource;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACjC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EAExB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAQ/C,MAAM,UAAU,GAAG,uBAAuB,CAAC,IAAI,CAAC;IAC9C,SAAS,EAAE,IAAI;IACf,kBAAkB,EAAE,IAAI,CAAC,mFAAmF;CAC7G,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CACpC,CAAC,CAAC,MAAM,CAAC;IACP,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,QAAQ,EAAE,CAAC,CAAC,KAAK,CACf,CAAC,CAAC,MAAM,CAAC;QACP,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;QACd,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;QACzB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE;KACjC,CAAC,CACH;IACD,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;QAClB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACzB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;KAC7B,CAAC;IACF,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;CACzC,CAAC,CACH,CAAC;AAIF,MAAM,WAAW,GAA0C;IACzD,MAAM,CAAC,OAAO,EAAE,YAAY;QAC1B,MAAM,aAAa,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAE5D,MAAM,EACJ,SAAS,EACT,QAAQ,EACR,UAAU,EACV,aAAa,EACb,SAAS,EACT,cAAc,EAAE,mBAAmB,EACpC,GAAG,aAAa,CAAC;QAElB,MAAM,gBAAgB,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAC9C,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CACnE,CAAC;QAEF,MAAM,mBAAmB,GAGrB,CAAC,QAAkC,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,CAC5D,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAmB,CAAC,kBAAkB,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;YACpE,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,CAAmB,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;gBAC1E,MAAM,kBAAkB,GAAG;oBACzB,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;oBACnD,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI;iBAC3B,CAAC;gBAEF,OAAO,CAAC,GAAG,OAAO,EAAE,kBAAkB,CAAC,CAAC;YAC1C,CAAC,EAAE,EAAE,CAAC,CAAC;YACP,OAAO,CAAC,GAAG,kBAAkB,EAAE,GAAG,eAAe,CAAC,CAAC;QACrD,CAAC,EAAE,EAAE,CAAC,CAAC;QAET,MAAM,uBAAuB,GAAG,CAC9B,QAA6B,EAC7B,UAAkB,EAClB,KAAa,EACb,kBAAoC,EACpC,EAAE;YACF,MAAM,EACJ,QAAQ,EAAE,EAAE,gBAAgB,EAAE,EAC/B,GAAG,QAAQ,CAAC;YACb,MAAM,EAAE,aAAa,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAc,CAAC,gBAAgB,EAAE,SAAS,EAAE,EAAE;gBACvF,IAAI,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;oBAC1C,8BAA8B;oBAC9B,MAAM,qBAAqB,GAAuB;wBAChD,IAAI,EAAE;4BACJ,SAAS;4BACT,GAAG,gBAAgB,CAAC,SAAS,CAAC;yBAC/B;qBACF,CAAC;oBACF,MAAM,sBAAsB,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;oBAE9D,MAAM,aAAa,GAAG,sBAAsB;wBAC1C,CAAC,CAAC,SAAS,CACP,qBAAqB,EACrB,sBAAsB,IAAI,EAAE,CAC7B;wBACH,CAAC,CAAC,qBAAqB,CAAC;oBAC1B,OAAO,CAAC,GAAG,gBAAgB,EAAE,eAAe,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC;iBACzE;gBACD,OAAO,gBAAgB,CAAC;YAC1B,CAAC,EAAE,EAAE,CAAC,CAAC;QACT,CAAC,CAAC;QAEF,MAAM,SAAS,GAAG,gBAAgB,CAChC;YACE,SAAS,EAAE,gBAAgB;YAC3B,cAAc,EAAE;gBACd,cAAc,EAAE,kBAAkB;gBAClC,eAAe,EAAE,UAAU;gBAC3B,GAAG,mBAAmB;aACvB;YACD,aAAa;YACb,SAAS;YACT,WAAW,EAAE,mBAAmB;SACjC,EACD,YAAY,CACb,CAAC;QAEF,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CACjC,SAAS,CAAC,wBAAwB,CAAC,EAAE;YACnC,MAAM,QAAQ,GAAG,wBAAwB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAEpE,OAAO,gBAAgB,CAAiC;gBACtD,SAAS,EAAE,QAAQ;gBACnB,cAAc,EAAE;oBACd,cAAc,EAAE,kBAAkB;oBAClC,eAAe,EAAE,UAAU;oBAC3B,GAAG,mBAAmB;iBACvB;gBACD,aAAa;gBACb,SAAS;gBACT,WAAW,EAAE,uBAAuB;gBACpC,kBAAkB,EAAE,wBAAwB;aAC7C,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CAAC;QAEF,OAAO,YAAY,CAAC;IACtB,CAAC;CACF,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/dist/transformer.d.ts

@@ -0,0 +1,18 @@
+import { FigmaPage } from './types/index.js';
+declare const createFigmaPage: (pageData: Partial<FigmaPage>, prefixDir: string) => {
+    title: string | undefined;
+    data: {
+        source: string;
+    };
+    description: string | undefined;
+    route: string;
+    fullPath: string;
+    tags: string[];
+    content: string;
+} & {
+    content: string;
+    description?: string | undefined;
+    data: import("./types/index.js").FigmaPageData;
+    tags: string[];
+} & import("packages/types/dist/Page.js").Page;
+export default createFigmaPage;

package/dist/transformer.js

@@ -0,0 +1,18 @@
+import deepmerge from 'deepmerge';
+const createFigmaPage = (pageData, prefixDir) => {
+    const { data: { name, description, patternId, tags } = {} } = pageData;
+    const route = `${prefixDir}/${patternId}`.replace(/\./g, '_').toLowerCase();
+    const pageTags = tags ? tags.split(',') : [];
+    const figmaPage = {
+        title: name,
+        data: { source: 'FIGMA' },
+        description,
+        route,
+        fullPath: `${route}.json`,
+        tags: pageTags,
+        content: ``
+    };
+    return deepmerge(figmaPage, pageData);
+};
+export default createFigmaPage;
+//# sourceMappingURL=transformer.js.map

package/dist/transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformer.js","sourceRoot":"","sources":["../src/transformer.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAIlC,MAAM,eAAe,GAAG,CAAC,QAA4B,EAAE,SAAiB,EAAE,EAAE;IAC1E,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,GAAG,QAAQ,CAAC;IACvE,MAAM,KAAK,GAAG,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5E,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7C,MAAM,SAAS,GAAG;QAChB,KAAK,EAAE,IAAI;QACX,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE;QACzB,WAAW;QACX,KAAK;QACL,QAAQ,EAAE,GAAG,KAAK,OAAO;QACzB,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,EAAE;KACZ,CAAC;IACF,OAAO,SAAS,CAA8B,SAAS,EAAE,QAAQ,CAAC,CAAC;AACrE,CAAC,CAAC;AAEF,eAAe,eAAe,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,45 @@
+import type { Page } from '@jpmorganchase/mosaic-types';
+/** Get project response */
+export declare type ProjectResponseJson = {
+    document: {
+        id: string;
+        name: string;
+        sharedPluginData: Record<string, any>;
+    };
+    name: string;
+    lastModified: string;
+    thumbnailUrl: string;
+    version: string;
+};
+export declare type ProjectFile = {
+    key: string;
+    thumbnail_url: string;
+    last_modified: string;
+    branches?: ProjectFile[];
+};
+/** Get project files response */
+export declare type ProjectFilesResponseJson = {
+    name: string;
+    files: ProjectFile[];
+};
+export declare type FileUrlAndMeta = {
+    fileUrl: string;
+    meta?: Record<string, unknown>;
+};
+/** Figma page Metadata */
+export declare type FigmaPageData = {
+    name: string;
+    patternId: string;
+    description: string;
+    embedLink: string;
+    link: string;
+    source: 'FIGMA';
+    tags?: string;
+};
+/** Figma page */
+export declare type FigmaPage = {
+    content: string;
+    description?: string;
+    data: FigmaPageData;
+    tags: string[];
+} & Page;

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@jpmorganchase/mosaic-source-figma",
+  "version": "0.1.0-beta.59",
+  "author": "",
+  "description": "Mosaic Figma source for core file system",
+  "license": "Apache-2.0",
+  "main": "./dist/index.js",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "node": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "engines": {
+    "node": ">= 16.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -fr dist",
+    "lint": "eslint --ignore-pattern \"**/__tests__/**\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:jpmorganchase/mosaic.git"
+  },
+  "dependencies": {
+    "@jpmorganchase/mosaic-source-http": "^0.1.0-beta.59",
+    "@jpmorganchase/mosaic-schemas": "^0.1.0-beta.59",
+    "@jpmorganchase/mosaic-types": "^0.1.0-beta.59",
+    "deepmerge": "^4.2.2",
+    "rxjs": "^7.5.5",
+    "zod": "^3.22.3"
+  },
+  "devDependencies": {
+    "msw": "^0.47.4"
+  }
+}