@dmptool/types 1.0.0

package/dist/dateQuestions.d.ts

@@ -0,0 +1,244 @@
+import { z } from "zod";
+export declare const DatePickerQuestion: z.ZodObject<{
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+        labelTranslationKey: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    }, {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    }>;
+} & {
+    type: z.ZodLiteral<"datePicker">;
+    attributes: z.ZodObject<{
+        max: z.ZodOptional<z.ZodString>;
+        min: z.ZodOptional<z.ZodString>;
+        step: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        max?: string | undefined;
+        min?: string | undefined;
+        step?: number | undefined;
+    }, {
+        max?: string | undefined;
+        min?: string | undefined;
+        step?: number | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "datePicker";
+    meta: {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    };
+    attributes: {
+        max?: string | undefined;
+        min?: string | undefined;
+        step?: number | undefined;
+    };
+}, {
+    type: "datePicker";
+    meta: {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    };
+    attributes: {
+        max?: string | undefined;
+        min?: string | undefined;
+        step?: number | undefined;
+    };
+}>;
+export declare const DateRangeQuestion: z.ZodObject<{
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+        labelTranslationKey: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    }, {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    }>;
+} & {
+    type: z.ZodLiteral<"dateRange">;
+    columns: z.ZodObject<{
+        start: z.ZodObject<{
+            meta: z.ZodObject<{
+                schemaVersion: z.ZodLiteral<"1.0">;
+                labelTranslationKey: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            }, {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            }>;
+            type: z.ZodLiteral<"datePicker">;
+        } & {
+            attributes: z.ZodObject<{
+                label: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                label: string;
+            }, {
+                label: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        }, {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        }>;
+        end: z.ZodObject<{
+            meta: z.ZodObject<{
+                schemaVersion: z.ZodLiteral<"1.0">;
+                labelTranslationKey: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            }, {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            }>;
+            type: z.ZodLiteral<"datePicker">;
+        } & {
+            attributes: z.ZodObject<{
+                label: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                label: string;
+            }, {
+                label: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        }, {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        start: {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        };
+        end: {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        };
+    }, {
+        start: {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        };
+        end: {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "dateRange";
+    meta: {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    };
+    columns: {
+        start: {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        };
+        end: {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        };
+    };
+}, {
+    type: "dateRange";
+    meta: {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    };
+    columns: {
+        start: {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        };
+        end: {
+            type: "datePicker";
+            meta: {
+                schemaVersion: "1.0";
+                labelTranslationKey?: string | undefined;
+            };
+            attributes: {
+                label: string;
+            };
+        };
+    };
+}>;
+export type DatePickerQuestionType = z.infer<typeof DatePickerQuestion>;
+export type DateRangeQuestionType = z.infer<typeof DateRangeQuestion>;

package/dist/dateQuestions.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DateRangeQuestion = exports.DatePickerQuestion = void 0;
+const zod_1 = require("zod");
+const primitiveQuestions_1 = require("./primitiveQuestions");
+// Date picker question and answer
+exports.DatePickerQuestion = primitiveQuestions_1.Question.merge(zod_1.z.object({
+    type: zod_1.z.literal('datePicker'), // The type of question
+    attributes: zod_1.z.object({
+        max: zod_1.z.string().optional(), // The maximum date (no default)
+        min: zod_1.z.string().optional(), // The minimum date (no default)
+        step: zod_1.z.number().optional() // The step value (default is 1 day)
+    })
+}));
+// Date range question and answer
+exports.DateRangeQuestion = primitiveQuestions_1.Question.merge(zod_1.z.object({
+    type: zod_1.z.literal('dateRange'), // The type of question
+    columns: zod_1.z.object({
+        start: exports.DatePickerQuestion.merge(zod_1.z.object({
+            attributes: zod_1.z.object({
+                label: zod_1.z.string() // The label for the start date picker
+            })
+        })),
+        end: exports.DatePickerQuestion.merge(zod_1.z.object({
+            attributes: zod_1.z.object({
+                label: zod_1.z.string() // The label for the end date picker
+            })
+        }))
+    })
+}));

package/dist/graphQLQuestions.d.ts

@@ -0,0 +1,288 @@
+import { z } from "zod";
+export declare const FilteredSearchQuestion: z.ZodObject<{
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+        labelTranslationKey: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    }, {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    }>;
+} & {
+    type: z.ZodLiteral<"filteredSearch">;
+    graphQL: z.ZodObject<{
+        displayFields: z.ZodArray<z.ZodObject<{
+            propertyName: z.ZodString;
+            label: z.ZodString;
+            labelTranslationKey: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }, {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }>, "many">;
+        localQueryId: z.ZodOptional<z.ZodString>;
+        query: z.ZodOptional<z.ZodString>;
+        responseField: z.ZodString;
+        variables: z.ZodArray<z.ZodObject<{
+            minLength: z.ZodOptional<z.ZodNumber>;
+            label: z.ZodOptional<z.ZodString>;
+            labelTranslationKey: z.ZodOptional<z.ZodString>;
+            name: z.ZodString;
+            type: z.ZodString;
+            defaultValue: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }, {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        displayFields: {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }[];
+        responseField: string;
+        variables: {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }[];
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+    }, {
+        displayFields: {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }[];
+        responseField: string;
+        variables: {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }[];
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+    }>;
+    attributes: z.ZodObject<{
+        multiple: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        multiple?: boolean | undefined;
+    }, {
+        multiple?: boolean | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "filteredSearch";
+    meta: {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    };
+    attributes: {
+        multiple?: boolean | undefined;
+    };
+    graphQL: {
+        displayFields: {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }[];
+        responseField: string;
+        variables: {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }[];
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+    };
+}, {
+    type: "filteredSearch";
+    meta: {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    };
+    attributes: {
+        multiple?: boolean | undefined;
+    };
+    graphQL: {
+        displayFields: {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }[];
+        responseField: string;
+        variables: {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }[];
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+    };
+}>;
+export declare const TypeaheadSearchQuestion: z.ZodObject<{
+    meta: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<"1.0">;
+        labelTranslationKey: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    }, {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    }>;
+} & {
+    type: z.ZodLiteral<"typeaheadSearch">;
+    graphQL: z.ZodObject<{
+        displayFields: z.ZodArray<z.ZodObject<{
+            propertyName: z.ZodString;
+            label: z.ZodString;
+            labelTranslationKey: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }, {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }>, "many">;
+        localQueryId: z.ZodOptional<z.ZodString>;
+        query: z.ZodOptional<z.ZodString>;
+        responseField: z.ZodString;
+        variables: z.ZodArray<z.ZodObject<{
+            minLength: z.ZodOptional<z.ZodNumber>;
+            label: z.ZodOptional<z.ZodString>;
+            labelTranslationKey: z.ZodOptional<z.ZodString>;
+            name: z.ZodString;
+            type: z.ZodString;
+            defaultValue: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }, {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        displayFields: {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }[];
+        responseField: string;
+        variables: {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }[];
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+    }, {
+        displayFields: {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }[];
+        responseField: string;
+        variables: {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }[];
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "typeaheadSearch";
+    meta: {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    };
+    graphQL: {
+        displayFields: {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }[];
+        responseField: string;
+        variables: {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }[];
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+    };
+}, {
+    type: "typeaheadSearch";
+    meta: {
+        schemaVersion: "1.0";
+        labelTranslationKey?: string | undefined;
+    };
+    graphQL: {
+        displayFields: {
+            label: string;
+            propertyName: string;
+            labelTranslationKey?: string | undefined;
+        }[];
+        responseField: string;
+        variables: {
+            type: string;
+            name: string;
+            labelTranslationKey?: string | undefined;
+            minLength?: number | undefined;
+            label?: string | undefined;
+            defaultValue?: string | undefined;
+        }[];
+        localQueryId?: string | undefined;
+        query?: string | undefined;
+    };
+}>;
+export type FilteredSearchQuestionType = z.infer<typeof FilteredSearchQuestion>;
+export type TypeaheadSearchQuestionType = z.infer<typeof TypeaheadSearchQuestion>;

package/dist/graphQLQuestions.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeaheadSearchQuestion = exports.FilteredSearchQuestion = void 0;
+const zod_1 = require("zod");
+const primitiveQuestions_1 = require("./primitiveQuestions");
+// An input variable for a GraphQL query
+const GraphQLVariable = zod_1.z.object({
+    minLength: zod_1.z.number().optional(), // A min length for the variable before executing the query
+    label: zod_1.z.string().optional(), // The label for the variable (default to the name)
+    labelTranslationKey: zod_1.z.string().optional(), // The translation key for the label (DMP Tool only)
+    name: zod_1.z.string(), // MUST match the input variable name in the query
+    type: zod_1.z.string(), // The type of the variable (default is string)
+    defaultValue: zod_1.z.string().optional() // The default value for the variable (no default)
+});
+// A property from a GraphQL query response that will be displayed to the user
+const GraphQLDisplayField = zod_1.z.object({
+    propertyName: zod_1.z.string(), // MUST match a property name in the query response
+    label: zod_1.z.string(), // The label for the field
+    labelTranslationKey: zod_1.z.string().optional() // The translation key for the label (DMP Tool only)
+});
+// A GraphQL query object
+const GraphQLQuery = zod_1.z.object({
+    displayFields: zod_1.z.array(GraphQLDisplayField), // The fields to display from the query response
+    localQueryId: zod_1.z.string().optional(), // The ID of the query (required if no query)
+    query: zod_1.z.string().optional(), // The GraphQL query to execute (required if no localQueryId)
+    responseField: zod_1.z.string(), // How to get at the location of displayFields in the response
+    variables: zod_1.z.array(GraphQLVariable) // The variables for the query
+});
+// Filtered search question and answer
+exports.FilteredSearchQuestion = primitiveQuestions_1.Question.merge(zod_1.z.object({
+    type: zod_1.z.literal('filteredSearch'), // The type of question
+    graphQL: GraphQLQuery, // The GraphQL query options for the filtered search
+    attributes: zod_1.z.object({
+        multiple: zod_1.z.boolean().optional() // Whether to allow multiple selections (default is true)
+    })
+}));
+// Typeahead search question and answer
+exports.TypeaheadSearchQuestion = primitiveQuestions_1.Question.merge(zod_1.z.object({
+    type: zod_1.z.literal('typeaheadSearch'), // The type of question
+    graphQL: GraphQLQuery, // The GraphQL query options for the typeahead search
+}));