@liase/core 1.0.0

package/dist/test/fixtures/examplePlugin.d.ts

@@ -0,0 +1,266 @@
+declare const _default: {
+    sources: {
+        readonly id: "example-source";
+        readonly displayName: "Example Source";
+        readonly description: "";
+        readonly requestHandlers: [{
+            readonly id: "single-media";
+            readonly displayName: "Single media";
+            readonly description: "";
+            readonly requestSchema: import("zod").ZodObject<{
+                source: import("zod").ZodString;
+                queryType: import("zod").ZodString;
+                id: import("zod").ZodString;
+            }, "strict", import("zod").ZodTypeAny, {
+                source: string;
+                queryType: string;
+                id: string;
+            }, {
+                source: string;
+                queryType: string;
+                id: string;
+            }>;
+            readonly paginationType: "none";
+            readonly responses: [{
+                readonly schema: import("zod").ZodObject<Omit<{
+                    page: import("zod").ZodObject<{
+                        paginationType: import("zod").ZodLiteral<"offset">;
+                        pageNumber: import("zod").ZodNumber;
+                        isLastPage: import("zod").ZodBoolean;
+                        pageFetchLimitReached: import("zod").ZodBoolean;
+                    }, "strict", import("zod").ZodTypeAny, {
+                        pageNumber: number;
+                        paginationType: "offset";
+                        pageFetchLimitReached: boolean;
+                        isLastPage: boolean;
+                    }, {
+                        pageNumber: number;
+                        paginationType: "offset";
+                        pageFetchLimitReached: boolean;
+                        isLastPage: boolean;
+                    }>;
+                    media: import("zod").ZodArray<import("zod").ZodObject<{
+                        mediaFinderSource: import("zod").ZodLiteral<"example-source">;
+                        id: import("zod").ZodString;
+                        title: import("zod").ZodString;
+                        files: import("zod").ZodArray<import("zod").ZodObject<{
+                            type: import("zod").ZodLiteral<"full">;
+                            url: import("zod").ZodString;
+                            ext: import("zod").ZodString;
+                        }, "strict", import("zod").ZodTypeAny, {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }, {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }>, "many">;
+                    }, "strict", import("zod").ZodTypeAny, {
+                        mediaFinderSource: "example-source";
+                        id: string;
+                        title: string;
+                        files: {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }[];
+                    }, {
+                        mediaFinderSource: "example-source";
+                        id: string;
+                        title: string;
+                        files: {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }[];
+                    }>, "many">;
+                    request: import("zod").ZodObject<{}, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{}, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">>;
+                }, "page">, "strict", import("zod").ZodTypeAny, {
+                    request: {} & {
+                        [k: string]: unknown;
+                    };
+                    media: {
+                        mediaFinderSource: "example-source";
+                        id: string;
+                        title: string;
+                        files: {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }[];
+                    }[];
+                }, {
+                    request: {} & {
+                        [k: string]: unknown;
+                    };
+                    media: {
+                        mediaFinderSource: "example-source";
+                        id: string;
+                        title: string;
+                        files: {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }[];
+                    }[];
+                }>;
+                readonly constructor: {
+                    readonly _setup: ($: import("../../ActionContext.js").ActionContext) => Promise<{
+                        statusCode: number;
+                        headers: Record<string, string>;
+                        cached: boolean;
+                        cachedOn: Date | null;
+                        request: {
+                            headers: Record<string, string>;
+                        };
+                    } & {
+                        root: import("../../DomSelection.js").DomSelection;
+                    }>;
+                    readonly media: [{
+                        readonly mediaFinderSource: () => string;
+                        readonly id: "1234";
+                        readonly title: ($: import("../../ActionContext.js").ActionContext) => any;
+                        readonly files: [];
+                    }];
+                    readonly request: ($: import("../../ActionContext.js").ActionContext) => Record<string, any>;
+                };
+            }];
+        }, {
+            readonly id: "search-media";
+            readonly displayName: "Search media";
+            readonly description: "";
+            readonly requestSchema: import("zod").ZodObject<{
+                source: import("zod").ZodString;
+                queryType: import("zod").ZodString;
+                searchText: import("zod").ZodString;
+                pageNumber: import("zod").ZodDefault<import("zod").ZodNumber>;
+            }, "strict", import("zod").ZodTypeAny, {
+                source: string;
+                queryType: string;
+                pageNumber: number;
+                searchText: string;
+            }, {
+                source: string;
+                queryType: string;
+                searchText: string;
+                pageNumber?: number | undefined;
+            }>;
+            readonly paginationType: "offset";
+            readonly responses: [{
+                readonly schema: import("zod").ZodObject<{
+                    page: import("zod").ZodObject<{
+                        paginationType: import("zod").ZodLiteral<"offset">;
+                        pageNumber: import("zod").ZodNumber;
+                        isLastPage: import("zod").ZodBoolean;
+                        pageFetchLimitReached: import("zod").ZodBoolean;
+                    }, "strict", import("zod").ZodTypeAny, {
+                        pageNumber: number;
+                        paginationType: "offset";
+                        pageFetchLimitReached: boolean;
+                        isLastPage: boolean;
+                    }, {
+                        pageNumber: number;
+                        paginationType: "offset";
+                        pageFetchLimitReached: boolean;
+                        isLastPage: boolean;
+                    }>;
+                    media: import("zod").ZodArray<import("zod").ZodObject<{
+                        mediaFinderSource: import("zod").ZodLiteral<"example-source">;
+                        id: import("zod").ZodString;
+                        title: import("zod").ZodString;
+                        files: import("zod").ZodArray<import("zod").ZodObject<{
+                            type: import("zod").ZodLiteral<"full">;
+                            url: import("zod").ZodString;
+                            ext: import("zod").ZodString;
+                        }, "strict", import("zod").ZodTypeAny, {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }, {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }>, "many">;
+                    }, "strict", import("zod").ZodTypeAny, {
+                        mediaFinderSource: "example-source";
+                        id: string;
+                        title: string;
+                        files: {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }[];
+                    }, {
+                        mediaFinderSource: "example-source";
+                        id: string;
+                        title: string;
+                        files: {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }[];
+                    }>, "many">;
+                    request: import("zod").ZodObject<{}, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{}, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">>;
+                }, "strict", import("zod").ZodTypeAny, {
+                    request: {} & {
+                        [k: string]: unknown;
+                    };
+                    media: {
+                        mediaFinderSource: "example-source";
+                        id: string;
+                        title: string;
+                        files: {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }[];
+                    }[];
+                    page: {
+                        pageNumber: number;
+                        paginationType: "offset";
+                        pageFetchLimitReached: boolean;
+                        isLastPage: boolean;
+                    };
+                }, {
+                    request: {} & {
+                        [k: string]: unknown;
+                    };
+                    media: {
+                        mediaFinderSource: "example-source";
+                        id: string;
+                        title: string;
+                        files: {
+                            type: "full";
+                            url: string;
+                            ext: string;
+                        }[];
+                    }[];
+                    page: {
+                        pageNumber: number;
+                        paginationType: "offset";
+                        pageFetchLimitReached: boolean;
+                        isLastPage: boolean;
+                    };
+                }>;
+                readonly constructor: {
+                    readonly page: {
+                        readonly paginationType: "offset";
+                        readonly pageNumber: ($: import("../../ActionContext.js").ActionContext) => any;
+                        readonly isLastPage: ($: import("../../ActionContext.js").ActionContext) => boolean;
+                        readonly pageFetchLimitReached: ($: import("../../ActionContext.js").ActionContext) => boolean | undefined;
+                    };
+                    readonly media: [{
+                        readonly mediaFinderSource: "example-source";
+                        readonly id: ($: import("../../ActionContext.js").ActionContext) => string;
+                        readonly title: "Media Title";
+                        readonly files: [];
+                    }];
+                    readonly request: ($: import("../../ActionContext.js").ActionContext) => Record<string, any>;
+                };
+            }];
+        }];
+    }[];
+};
+export default _default;
+//# sourceMappingURL=examplePlugin.d.ts.map

package/dist/test/fixtures/examplePlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"examplePlugin.d.ts","sourceRoot":"","sources":["../../../test/fixtures/examplePlugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA,wBAEmB"}

package/dist/test/fixtures/examplePlugin.js

@@ -0,0 +1,4 @@
+import exampleSource from "./exampleSource.js";
+export default {
+    sources: [exampleSource],
+};

package/dist/test/fixtures/exampleSource.d.ts

@@ -0,0 +1,265 @@
+import { z } from "zod";
+declare const _default: {
+    readonly id: "example-source";
+    readonly displayName: "Example Source";
+    readonly description: "";
+    readonly requestHandlers: [{
+        readonly id: "single-media";
+        readonly displayName: "Single media";
+        readonly description: "";
+        readonly requestSchema: z.ZodObject<{
+            source: z.ZodString;
+            queryType: z.ZodString;
+            id: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            source: string;
+            queryType: string;
+            id: string;
+        }, {
+            source: string;
+            queryType: string;
+            id: string;
+        }>;
+        readonly paginationType: "none";
+        readonly responses: [{
+            readonly schema: z.ZodObject<Omit<{
+                page: z.ZodObject<{
+                    paginationType: z.ZodLiteral<"offset">;
+                    pageNumber: z.ZodNumber;
+                    isLastPage: z.ZodBoolean;
+                    pageFetchLimitReached: z.ZodBoolean;
+                }, "strict", z.ZodTypeAny, {
+                    pageNumber: number;
+                    paginationType: "offset";
+                    pageFetchLimitReached: boolean;
+                    isLastPage: boolean;
+                }, {
+                    pageNumber: number;
+                    paginationType: "offset";
+                    pageFetchLimitReached: boolean;
+                    isLastPage: boolean;
+                }>;
+                media: z.ZodArray<z.ZodObject<{
+                    mediaFinderSource: z.ZodLiteral<"example-source">;
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    files: z.ZodArray<z.ZodObject<{
+                        type: z.ZodLiteral<"full">;
+                        url: z.ZodString;
+                        ext: z.ZodString;
+                    }, "strict", z.ZodTypeAny, {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }, {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }>, "many">;
+                }, "strict", z.ZodTypeAny, {
+                    mediaFinderSource: "example-source";
+                    id: string;
+                    title: string;
+                    files: {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }[];
+                }, {
+                    mediaFinderSource: "example-source";
+                    id: string;
+                    title: string;
+                    files: {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }[];
+                }>, "many">;
+                request: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+            }, "page">, "strict", z.ZodTypeAny, {
+                request: {} & {
+                    [k: string]: unknown;
+                };
+                media: {
+                    mediaFinderSource: "example-source";
+                    id: string;
+                    title: string;
+                    files: {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }[];
+                }[];
+            }, {
+                request: {} & {
+                    [k: string]: unknown;
+                };
+                media: {
+                    mediaFinderSource: "example-source";
+                    id: string;
+                    title: string;
+                    files: {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }[];
+                }[];
+            }>;
+            readonly constructor: {
+                readonly _setup: ($: import("../../ActionContext.js").ActionContext) => Promise<{
+                    statusCode: number;
+                    headers: Record<string, string>;
+                    cached: boolean;
+                    cachedOn: Date | null;
+                    request: {
+                        headers: Record<string, string>;
+                    };
+                } & {
+                    root: import("../../DomSelection.js").DomSelection;
+                }>;
+                readonly media: [{
+                    readonly mediaFinderSource: () => string;
+                    readonly id: "1234";
+                    readonly title: ($: import("../../ActionContext.js").ActionContext) => any;
+                    readonly files: [];
+                }];
+                readonly request: ($: import("../../ActionContext.js").ActionContext) => Record<string, any>;
+            };
+        }];
+    }, {
+        readonly id: "search-media";
+        readonly displayName: "Search media";
+        readonly description: "";
+        readonly requestSchema: z.ZodObject<{
+            source: z.ZodString;
+            queryType: z.ZodString;
+            searchText: z.ZodString;
+            pageNumber: z.ZodDefault<z.ZodNumber>;
+        }, "strict", z.ZodTypeAny, {
+            source: string;
+            queryType: string;
+            pageNumber: number;
+            searchText: string;
+        }, {
+            source: string;
+            queryType: string;
+            searchText: string;
+            pageNumber?: number | undefined;
+        }>;
+        readonly paginationType: "offset";
+        readonly responses: [{
+            readonly schema: z.ZodObject<{
+                page: z.ZodObject<{
+                    paginationType: z.ZodLiteral<"offset">;
+                    pageNumber: z.ZodNumber;
+                    isLastPage: z.ZodBoolean;
+                    pageFetchLimitReached: z.ZodBoolean;
+                }, "strict", z.ZodTypeAny, {
+                    pageNumber: number;
+                    paginationType: "offset";
+                    pageFetchLimitReached: boolean;
+                    isLastPage: boolean;
+                }, {
+                    pageNumber: number;
+                    paginationType: "offset";
+                    pageFetchLimitReached: boolean;
+                    isLastPage: boolean;
+                }>;
+                media: z.ZodArray<z.ZodObject<{
+                    mediaFinderSource: z.ZodLiteral<"example-source">;
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    files: z.ZodArray<z.ZodObject<{
+                        type: z.ZodLiteral<"full">;
+                        url: z.ZodString;
+                        ext: z.ZodString;
+                    }, "strict", z.ZodTypeAny, {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }, {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }>, "many">;
+                }, "strict", z.ZodTypeAny, {
+                    mediaFinderSource: "example-source";
+                    id: string;
+                    title: string;
+                    files: {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }[];
+                }, {
+                    mediaFinderSource: "example-source";
+                    id: string;
+                    title: string;
+                    files: {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }[];
+                }>, "many">;
+                request: z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>;
+            }, "strict", z.ZodTypeAny, {
+                request: {} & {
+                    [k: string]: unknown;
+                };
+                media: {
+                    mediaFinderSource: "example-source";
+                    id: string;
+                    title: string;
+                    files: {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }[];
+                }[];
+                page: {
+                    pageNumber: number;
+                    paginationType: "offset";
+                    pageFetchLimitReached: boolean;
+                    isLastPage: boolean;
+                };
+            }, {
+                request: {} & {
+                    [k: string]: unknown;
+                };
+                media: {
+                    mediaFinderSource: "example-source";
+                    id: string;
+                    title: string;
+                    files: {
+                        type: "full";
+                        url: string;
+                        ext: string;
+                    }[];
+                }[];
+                page: {
+                    pageNumber: number;
+                    paginationType: "offset";
+                    pageFetchLimitReached: boolean;
+                    isLastPage: boolean;
+                };
+            }>;
+            readonly constructor: {
+                readonly page: {
+                    readonly paginationType: "offset";
+                    readonly pageNumber: ($: import("../../ActionContext.js").ActionContext) => any;
+                    readonly isLastPage: ($: import("../../ActionContext.js").ActionContext) => boolean;
+                    readonly pageFetchLimitReached: ($: import("../../ActionContext.js").ActionContext) => boolean | undefined;
+                };
+                readonly media: [{
+                    readonly mediaFinderSource: "example-source";
+                    readonly id: ($: import("../../ActionContext.js").ActionContext) => string;
+                    readonly title: "Media Title";
+                    readonly files: [];
+                }];
+                readonly request: ($: import("../../ActionContext.js").ActionContext) => Record<string, any>;
+            };
+        }];
+    }];
+};
+export default _default;
+//# sourceMappingURL=exampleSource.d.ts.map

package/dist/test/fixtures/exampleSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exampleSource.d.ts","sourceRoot":"","sources":["../../../test/fixtures/exampleSource.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCxB,wBA2E4B"}

package/dist/test/fixtures/exampleSource.js

@@ -0,0 +1,107 @@
+import { z } from "zod";
+const sourceName = "Example Source";
+const sourceId = "example-source";
+const exampleFileSchema = z
+    .object({
+    type: z.literal("full"),
+    url: z.string().url(),
+    ext: z.string().regex(/^\w+$/),
+})
+    .strict();
+const exampleMediaSchema = z
+    .object({
+    mediaFinderSource: z.literal(sourceId),
+    id: z.string(),
+    title: z.string(),
+    files: z.array(exampleFileSchema),
+})
+    .strict();
+const exampleResponseSchema = z
+    .object({
+    page: z
+        .object({
+        paginationType: z.literal("offset"),
+        pageNumber: z.number().int(),
+        isLastPage: z.boolean(),
+        pageFetchLimitReached: z.boolean(),
+    })
+        .strict(),
+    media: z.array(exampleMediaSchema),
+    request: z.object({}).passthrough(),
+})
+    .strict();
+export default {
+    id: sourceId,
+    displayName: sourceName,
+    description: "",
+    requestHandlers: [
+        {
+            id: "single-media",
+            displayName: "Single media",
+            description: "",
+            requestSchema: z
+                .object({
+                source: z.string(),
+                queryType: z.string(),
+                id: z.string(),
+            })
+                .strict(),
+            paginationType: "none",
+            responses: [
+                {
+                    schema: exampleResponseSchema.omit({ page: true }),
+                    constructor: {
+                        _setup: ($) => $.loadUrl("https://example.com/"),
+                        media: [
+                            {
+                                mediaFinderSource: () => sourceId,
+                                id: "1234",
+                                title: ($) => $.request.id === "test-getWebpage"
+                                    ? $().root.select("h1")
+                                    : "Media Title",
+                                files: [],
+                            },
+                        ],
+                        request: ($) => $.request,
+                    },
+                },
+            ],
+        },
+        {
+            id: "search-media",
+            displayName: "Search media",
+            description: "",
+            requestSchema: z
+                .object({
+                source: z.string(),
+                queryType: z.string(),
+                searchText: z.string(),
+                pageNumber: z.number().default(1),
+            })
+                .strict(),
+            paginationType: "offset",
+            responses: [
+                {
+                    schema: exampleResponseSchema,
+                    constructor: {
+                        page: {
+                            paginationType: "offset",
+                            pageNumber: ($) => $.request.pageNumber ?? 1,
+                            isLastPage: ($) => $.request.pageNumber >= 2,
+                            pageFetchLimitReached: ($) => $.pageFetchLimitReached,
+                        },
+                        media: [
+                            {
+                                mediaFinderSource: sourceId,
+                                id: ($) => `${$.request.pageNumber}-a`,
+                                title: "Media Title",
+                                files: [],
+                            },
+                        ],
+                        request: ($) => $.request,
+                    },
+                },
+            ],
+        },
+    ],
+};

package/dist/test/testFiles/internal/caching.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=caching.test.d.ts.map

package/dist/test/testFiles/internal/caching.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"caching.test.d.ts","sourceRoot":"","sources":["../../../../test/testFiles/internal/caching.test.ts"],"names":[],"mappings":""}