@jpmorganchase/mosaic-source-readme 0.1.0-beta.60

package/dist/index.d.ts

@@ -0,0 +1,219 @@
+import { z } from 'zod';
+import type { Source } from '@jpmorganchase/mosaic-types';
+import { ReadmePage } from './types/index.js';
+declare const readMeSchema: z.ZodObject<{
+    accessToken: z.ZodOptional<z.ZodString>;
+    proxyEndpoint: z.ZodOptional<z.ZodString>;
+    contentTemplate: z.ZodString;
+    readmeUrl: z.ZodString;
+    name: z.ZodString;
+    meta: z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodString;
+        layout: z.ZodString;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        data: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        description: string;
+        layout: string;
+        tags?: string[] | undefined;
+        data?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    }, {
+        title: string;
+        description: string;
+        layout: string;
+        tags?: string[] | undefined;
+        data?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    contentTemplate: string;
+    readmeUrl: string;
+    name: string;
+    meta: {
+        title: string;
+        description: string;
+        layout: string;
+        tags?: string[] | undefined;
+        data?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    };
+    accessToken?: string | undefined;
+    proxyEndpoint?: string | undefined;
+}, {
+    contentTemplate: string;
+    readmeUrl: string;
+    name: string;
+    meta: {
+        title: string;
+        description: string;
+        layout: string;
+        tags?: string[] | undefined;
+        data?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+    };
+    accessToken?: string | undefined;
+    proxyEndpoint?: string | undefined;
+}>;
+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;
+    }>>;
+    prefixDir: z.ZodString;
+    requestTimeout: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    proxyEndpoint: z.ZodOptional<z.ZodString>;
+    requestHeaders: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+    readme: z.ZodArray<z.ZodObject<{
+        accessToken: z.ZodOptional<z.ZodString>;
+        proxyEndpoint: z.ZodOptional<z.ZodString>;
+        contentTemplate: z.ZodString;
+        readmeUrl: z.ZodString;
+        name: z.ZodString;
+        meta: z.ZodObject<{
+            title: z.ZodString;
+            description: z.ZodString;
+            layout: z.ZodString;
+            tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            data: z.ZodOptional<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+        }, "strip", z.ZodTypeAny, {
+            title: string;
+            description: string;
+            layout: string;
+            tags?: string[] | undefined;
+            data?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+        }, {
+            title: string;
+            description: string;
+            layout: string;
+            tags?: string[] | undefined;
+            data?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        contentTemplate: string;
+        readmeUrl: string;
+        name: string;
+        meta: {
+            title: string;
+            description: string;
+            layout: string;
+            tags?: string[] | undefined;
+            data?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+        };
+        accessToken?: string | undefined;
+        proxyEndpoint?: string | undefined;
+    }, {
+        contentTemplate: string;
+        readmeUrl: string;
+        name: string;
+        meta: {
+            title: string;
+            description: string;
+            layout: string;
+            tags?: string[] | undefined;
+            data?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+        };
+        accessToken?: string | undefined;
+        proxyEndpoint?: string | undefined;
+    }>, "atleastone">;
+}, "strip", z.ZodTypeAny, {
+    prefixDir: string;
+    requestTimeout: number;
+    readme: [{
+        contentTemplate: string;
+        readmeUrl: string;
+        name: string;
+        meta: {
+            title: string;
+            description: string;
+            layout: string;
+            tags?: string[] | undefined;
+            data?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+        };
+        accessToken?: string | undefined;
+        proxyEndpoint?: string | undefined;
+    }, ...{
+        contentTemplate: string;
+        readmeUrl: string;
+        name: string;
+        meta: {
+            title: string;
+            description: string;
+            layout: string;
+            tags?: string[] | undefined;
+            data?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+        };
+        accessToken?: string | undefined;
+        proxyEndpoint?: string | undefined;
+    }[]];
+    schedule?: {
+        checkIntervalMins: number;
+        initialDelayMs: number;
+        retryEnabled: boolean;
+        retryDelayMins: number;
+        maxRetries: number;
+        resetOnSuccess: boolean;
+    } | undefined;
+    proxyEndpoint?: string | undefined;
+    requestHeaders?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    prefixDir: string;
+    readme: [{
+        contentTemplate: string;
+        readmeUrl: string;
+        name: string;
+        meta: {
+            title: string;
+            description: string;
+            layout: string;
+            tags?: string[] | undefined;
+            data?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+        };
+        accessToken?: string | undefined;
+        proxyEndpoint?: string | undefined;
+    }, ...{
+        contentTemplate: string;
+        readmeUrl: string;
+        name: string;
+        meta: {
+            title: string;
+            description: string;
+            layout: string;
+            tags?: string[] | undefined;
+            data?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+        };
+        accessToken?: string | undefined;
+        proxyEndpoint?: string | undefined;
+    }[]];
+    schedule?: {
+        checkIntervalMins: number;
+        initialDelayMs: number;
+        retryEnabled?: boolean | undefined;
+        retryDelayMins?: number | undefined;
+        maxRetries?: number | undefined;
+        resetOnSuccess?: boolean | undefined;
+    } | undefined;
+    requestTimeout?: number | undefined;
+    proxyEndpoint?: string | undefined;
+    requestHeaders?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+}>;
+export declare type ReadmeSourceOptions = z.infer<typeof schema>;
+export declare type ReadmeOptions = z.infer<typeof readMeSchema>;
+declare const ReadmeSource: Source<ReadmeSourceOptions, ReadmePage>;
+export default ReadmeSource;

package/dist/index.js

@@ -0,0 +1,82 @@
+import { map } from 'rxjs';
+import { z } from 'zod';
+import deepmerge from 'deepmerge';
+import { validateMosaicSchema } from '@jpmorganchase/mosaic-schemas';
+import { createHttpSource, httpSourceCreatorSchema, createProxyAgent } from '@jpmorganchase/mosaic-source-http';
+const baseSchema = httpSourceCreatorSchema.omit({
+    endpoints: true,
+    noProxy: true,
+    transformerOptions: true // readme is the prop we need for this so no point duplicating it in source config
+});
+const readMeSchema = z.object({
+    accessToken: z.string().optional(),
+    proxyEndpoint: z.string().url().optional(),
+    contentTemplate: z.string(),
+    readmeUrl: z.string(),
+    name: z.string(),
+    meta: z.object({
+        title: z.string(),
+        description: z.string(),
+        layout: z.string(),
+        tags: z.array(z.string()).optional(),
+        data: z.object({}).passthrough().optional()
+    })
+});
+export const schema = baseSchema.merge(z.object({
+    readme: z.array(readMeSchema).nonempty()
+}));
+const createReadmePage = (content, prefixDir, index, sourceOptions) => {
+    const { contentTemplate, meta, name, readmeUrl } = sourceOptions[index];
+    const { title, description } = meta;
+    const route = `${prefixDir}/${name}`;
+    const updatedContent = contentTemplate.replace('::content::', content);
+    const sourceMeta = {
+        title,
+        description,
+        route,
+        fullPath: `${route}.mdx`,
+        data: {
+            title,
+            description,
+            readmeUrl,
+            link: route
+        },
+        content: updatedContent
+    };
+    const configMeta = meta;
+    const readmePage = deepmerge(sourceMeta, configMeta);
+    return [readmePage];
+};
+const ReadmeSource = {
+    create(options, sourceConfig) {
+        const parsedOptions = validateMosaicSchema(schema, options);
+        const { requestTimeout, requestHeaders: requestHeadersParam, prefixDir, readme: readmeConfig, ...restOptions } = parsedOptions;
+        const configuredRequests = readmeConfig.map(config => {
+            const { accessToken, readmeUrl, proxyEndpoint } = config;
+            let agent;
+            if (proxyEndpoint) {
+                console.log(`[Mosaic] Readme source using ${proxyEndpoint} proxy for ${readmeUrl}`);
+                agent = createProxyAgent(proxyEndpoint);
+            }
+            let requestHeaders = accessToken ? { Authorization: accessToken } : {};
+            requestHeaders = { ...requestHeaders, 'Content-Type': 'text/html', ...requestHeadersParam };
+            return new Request(`${readmeUrl}`, {
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                agent,
+                headers: requestHeaders,
+                timeout: requestTimeout
+            });
+        });
+        const readmeHttpSource$ = createHttpSource({
+            prefixDir,
+            ...restOptions,
+            configuredRequests,
+            transformer: createReadmePage,
+            transformerOptions: readmeConfig
+        }, sourceConfig);
+        return readmeHttpSource$.pipe(map(pages => pages.flat()));
+    }
+};
+export default ReadmeSource;
+//# 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,GAAG,EAAE,MAAM,MAAM,CAAC;AAC3B,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,EACvB,gBAAgB,EACjB,MAAM,mCAAmC,CAAC;AAG3C,MAAM,UAAU,GAAG,uBAAuB,CAAC,IAAI,CAAC;IAC9C,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;IACb,kBAAkB,EAAE,IAAI,CAAC,kFAAkF;CAC5G,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC1C,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;QACvB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;QAClB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;QACpC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;KAC5C,CAAC;CACH,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CACpC,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;CACzC,CAAC,CACH,CAAC;AAEF,MAAM,gBAAgB,GAAG,CACvB,OAAe,EACf,SAAiB,EACjB,KAAa,EACb,aAA8B,EAChB,EAAE;IAChB,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;IACxE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACpC,MAAM,KAAK,GAAG,GAAG,SAAS,IAAI,IAAI,EAAE,CAAC;IACrC,MAAM,cAAc,GAAG,eAAe,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACvE,MAAM,UAAU,GAEZ;QACF,KAAK;QACL,WAAW;QACX,KAAK;QACL,QAAQ,EAAE,GAAG,KAAK,MAAM;QACxB,IAAI,EAAE;YACJ,KAAK;YACL,WAAW;YACX,SAAS;YACT,IAAI,EAAE,KAAK;SACZ;QACD,OAAO,EAAE,cAAc;KACxB,CAAC;IACF,MAAM,UAAU,GAAG,IAA2B,CAAC;IAC/C,MAAM,UAAU,GAAG,SAAS,CAAgC,UAAU,EAAE,UAAU,CAAC,CAAC;IACpF,OAAO,CAAC,UAAU,CAAC,CAAC;AACtB,CAAC,CAAC;AAKF,MAAM,YAAY,GAA4C;IAC5D,MAAM,CAAC,OAAO,EAAE,YAAY;QAC1B,MAAM,aAAa,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC5D,MAAM,EACJ,cAAc,EACd,cAAc,EAAE,mBAAmB,EACnC,SAAS,EACT,MAAM,EAAE,YAAY,EACpB,GAAG,WAAW,EACf,GAAG,aAAa,CAAC;QAClB,MAAM,kBAAkB,GAAG,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACnD,MAAM,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;YACzD,IAAI,KAAK,CAAC;YAEV,IAAI,aAAa,EAAE;gBACjB,OAAO,CAAC,GAAG,CAAC,gCAAgC,aAAa,cAAc,SAAS,EAAE,CAAC,CAAC;gBACpF,KAAK,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;aACzC;YAED,IAAI,cAAc,GAAgB,WAAW,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACpF,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,cAAc,EAAE,WAAW,EAAE,GAAG,mBAAmB,EAAE,CAAC;YAC5F,OAAO,IAAI,OAAO,CAAC,GAAG,SAAS,EAAE,EAAE;gBACjC,6DAA6D;gBAC7D,aAAa;gBACb,KAAK;gBACL,OAAO,EAAE,cAAc;gBACvB,OAAO,EAAE,cAAc;aACxB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,iBAAiB,GAAG,gBAAgB,CACxC;YACE,SAAS;YACT,GAAG,WAAW;YACd,kBAAkB;YAClB,WAAW,EAAE,gBAAgB;YAC7B,kBAAkB,EAAE,YAAY;SACjC,EACD,YAAY,CACb,CAAC;QAEF,OAAO,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC5D,CAAC;CACF,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,14 @@
+import type { Page } from '@jpmorganchase/mosaic-types';
+/** Readme specific metadata */
+export declare type ReadmePageData = {
+    title: string;
+    description: string;
+    link: string;
+    repoUrl: string;
+    readmeUrl: string;
+};
+/** Readme page */
+export declare type ReadmePage = {
+    description: string;
+    data: ReadmePageData;
+} & 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,42 @@
+{
+  "name": "@jpmorganchase/mosaic-source-readme",
+  "version": "0.1.0-beta.60",
+  "author": "",
+  "description": "Mosaic Readme.md 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"
+    }
+  },
+  "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.60",
+    "@jpmorganchase/mosaic-schemas": "^0.1.0-beta.60",
+    "@jpmorganchase/mosaic-types": "^0.1.0-beta.60",
+    "rxjs": "^7.5.5",
+    "zod": "^3.22.3"
+  },
+  "devDependencies": {
+    "msw": "^0.47.4"
+  }
+}