@dmptool/types 1.2.6 → 2.0.0

package/dist/questions/__tests__/usage.spec.js

@@ -1,473 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const question_1 = require("../question");
-const index_1 = require("../index");
-// Parse the Zod schema with no input to generate the default JSON schemas
-function questionFormatInfo(name) {
-    if (name in index_1.QuestionSchemaMap) {
-        const usage = question_1.QuestionFormatsUsage[name];
-        const schema = index_1.QuestionSchemaMap[name];
-        const parsedSchema = schema.parse({ type: name });
-        return {
-            type: name,
-            title: usage === null || usage === void 0 ? void 0 : usage.title,
-            usageDescription: usage === null || usage === void 0 ? void 0 : usage.usageDescription,
-            defaultJSON: parsedSchema
-        };
-    }
-    else {
-        return null;
-    }
-}
-describe('Get question format information', () => {
-    it('for affiliationSearch question format', () => {
-        const format = questionFormatInfo('affiliationSearch');
-        expect(format === null || format === void 0 ? void 0 : format.type).toEqual('affiliationSearch');
-        expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Affiliation Search');
-        expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-        const expectedJSON = {
-            type: 'affiliationSearch',
-            attributes: {},
-            meta: { schemaVersion: '1.0' },
-            graphQL: {
-                displayFields: [{
-                        label: "Institution",
-                        propertyName: "displayName",
-                    }],
-                query: index_1.affiliationQuery,
-                responseField: 'affiliations.items',
-                variables: [{
-                        label: "Search for your institution",
-                        minLength: 3,
-                        name: "name",
-                        type: "string",
-                    }],
-                answerField: 'uri'
-            }
-        };
-        expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-    });
-    it('for boolean question format', () => {
-        const format = questionFormatInfo('boolean');
-        expect(format === null || format === void 0 ? void 0 : format.type).toEqual('boolean');
-        expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Yes/No Field');
-        expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-        const expectedJSON = {
-            type: 'boolean',
-            attributes: { checked: false },
-            meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-        };
-        expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-    });
-    it('for checkBoxes question format', () => {
-        const format = questionFormatInfo('checkBoxes');
-        expect(format === null || format === void 0 ? void 0 : format.type).toEqual('checkBoxes');
-        expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Check Boxes');
-        expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-        const expectedJSON = {
-            type: 'checkBoxes',
-            attributes: {},
-            options: [{
-                    label: 'Option A',
-                    value: 'a',
-                    checked: false
-                }],
-            meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-        };
-        expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-    });
-    it('for currency question format', () => {
-        const format = questionFormatInfo('currency');
-        expect(format === null || format === void 0 ? void 0 : format.type).toEqual('currency');
-        expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Currency Field');
-        expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-        const expectedJSON = {
-            type: 'currency',
-            attributes: {
-                denomination: 'USD',
-                min: 0,
-                step: 1
-            },
-            meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-        };
-        expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-    });
-});
-it('for date question format', () => {
-    const format = questionFormatInfo('date');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('date');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Date Field');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'date',
-        attributes: {
-            step: 1
-        },
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for dateRange question format', () => {
-    const format = questionFormatInfo('dateRange');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('dateRange');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Date Range');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'dateRange',
-        attributes: {},
-        columns: {
-            start: {
-                label: 'From',
-                step: 1
-            },
-            end: {
-                label: 'To',
-                step: 1
-            }
-        },
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for email question format', () => {
-    const format = questionFormatInfo('email');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('email');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Email Field');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'email',
-        attributes: {
-            maxLength: 255,
-            multiple: false,
-        },
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for licenseSearch question format', () => {
-    const format = questionFormatInfo('licenseSearch');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('licenseSearch');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('License Search');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'licenseSearch',
-        attributes: {},
-        meta: { schemaVersion: '1.0' },
-        graphQL: {
-            displayFields: [
-                {
-                    label: "Name",
-                    propertyName: "name",
-                },
-                {
-                    label: "Description",
-                    propertyName: "description",
-                },
-                {
-                    label: "Recommended",
-                    propertyName: "recommended",
-                }
-            ],
-            query: index_1.licenseQuery,
-            responseField: 'licenses.items',
-            variables: [
-                {
-                    label: "Search for a license",
-                    minLength: 3,
-                    name: "term",
-                    type: "string",
-                },
-                {
-                    label: "Pagination Options",
-                    name: "paginationOptions",
-                    type: "paginationOptions",
-                }
-            ],
-            answerField: 'uri'
-        }
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for metadataStandardSearch question format', () => {
-    const format = questionFormatInfo('metadataStandardSearch');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('metadataStandardSearch');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Metadata Standard Search');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'metadataStandardSearch',
-        attributes: {},
-        meta: { schemaVersion: '1.0' },
-        graphQL: {
-            displayFields: [
-                {
-                    label: "Name",
-                    propertyName: "name",
-                },
-                {
-                    label: "Description",
-                    propertyName: "description",
-                },
-                {
-                    label: "Website",
-                    propertyName: "website",
-                },
-                {
-                    label: "Subject Areas",
-                    propertyName: "keywords",
-                }
-            ],
-            query: index_1.metadataStandardQuery,
-            responseField: 'metadataStandards.items',
-            variables: [
-                {
-                    label: "Search for a metadata standard",
-                    minLength: 3,
-                    name: "term",
-                    type: "string",
-                },
-                {
-                    label: "Subject Areas",
-                    name: "keywords",
-                    type: "string",
-                    minLength: 3,
-                },
-                {
-                    label: "Pagination Options",
-                    name: "paginationOptions",
-                    type: "paginationOptions",
-                }
-            ],
-            answerField: 'uri'
-        }
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for multiselectBox question format', () => {
-    const format = questionFormatInfo('multiselectBox');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('multiselectBox');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Multi-select Box');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'multiselectBox',
-        attributes: {
-            multiple: true,
-        },
-        options: [{
-                label: 'Option A',
-                value: 'a',
-                selected: false
-            }],
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for number question format', () => {
-    const format = questionFormatInfo('number');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('number');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Number Field');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'number',
-        attributes: {
-            min: 0,
-            step: 1,
-        },
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for numberRange format', () => {
-    const format = questionFormatInfo('numberRange');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('numberRange');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Number Range');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'numberRange',
-        attributes: {},
-        columns: {
-            start: {
-                label: 'From',
-                min: 0,
-                step: 1,
-            },
-            end: {
-                label: 'To',
-                min: 0,
-                step: 1,
-            }
-        },
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for radioButtons question format', () => {
-    const format = questionFormatInfo('radioButtons');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('radioButtons');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Radio Buttons');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'radioButtons',
-        attributes: {},
-        options: [{
-                label: 'Option A',
-                value: 'a',
-                selected: false
-            }],
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for repositorySearch question format', () => {
-    const format = questionFormatInfo('repositorySearch');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('repositorySearch');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Repository Search');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'repositorySearch',
-        attributes: {},
-        meta: { schemaVersion: '1.0' },
-        graphQL: {
-            displayFields: [
-                {
-                    label: "Name",
-                    propertyName: "name",
-                },
-                {
-                    label: "Description",
-                    propertyName: "description",
-                },
-                {
-                    label: "Website",
-                    propertyName: "website",
-                },
-                {
-                    label: "Subject Areas",
-                    propertyName: "keywords",
-                }
-            ],
-            query: index_1.repositoryQuery,
-            responseField: 'repositories.items',
-            variables: [
-                {
-                    label: "Search for a repository",
-                    minLength: 3,
-                    name: "term",
-                    type: "string",
-                },
-                {
-                    label: "Subject Areas",
-                    name: "keywords",
-                    type: "string",
-                    minLength: 3
-                },
-                {
-                    label: "Repository type",
-                    name: "repositoryType",
-                    type: "string",
-                    minLength: 3
-                },
-                {
-                    label: "Pagination Options",
-                    name: "paginationOptions",
-                    type: "paginationOptions",
-                }
-            ],
-            answerField: 'uri'
-        }
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for selectBox question format', () => {
-    const format = questionFormatInfo('selectBox');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('selectBox');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Select Box');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'selectBox',
-        attributes: {
-            multiple: false,
-        },
-        options: [{
-                label: 'Option A',
-                value: 'a',
-                selected: false
-            }],
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for table question format', () => {
-    const format = questionFormatInfo('table');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('table');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Table');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'table',
-        attributes: {
-            canAddRows: true,
-            canRemoveRows: true,
-            initialRows: 1
-        },
-        columns: [{
-                heading: 'Column A',
-                enabled: true,
-                required: false,
-                content: {
-                    type: 'textArea',
-                    attributes: {
-                        asRichText: true,
-                        cols: 20,
-                        rows: 2,
-                    },
-                    meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION }
-                },
-                meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION }
-            }],
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for text question format', () => {
-    const format = questionFormatInfo('text');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('text');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Text Field');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'text',
-        attributes: {
-            maxLength: 255,
-        },
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for textArea question format', () => {
-    const format = questionFormatInfo('textArea');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('textArea');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('Text Area');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'textArea',
-        attributes: {
-            asRichText: true,
-            cols: 20,
-            rows: 2,
-        },
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});
-it('for url question format', () => {
-    const format = questionFormatInfo('url');
-    expect(format === null || format === void 0 ? void 0 : format.type).toEqual('url');
-    expect(format === null || format === void 0 ? void 0 : format.title).toEqual('URL Field');
-    expect(format === null || format === void 0 ? void 0 : format.usageDescription).toBeDefined();
-    const expectedJSON = {
-        type: 'url',
-        attributes: {
-            maxLength: 255,
-        },
-        meta: { schemaVersion: question_1.CURRENT_SCHEMA_VERSION },
-    };
-    expect(format === null || format === void 0 ? void 0 : format.defaultJSON).toEqual(expectedJSON);
-});

package/dist/schemas/affiliationSearchAnswer.schema.json

@@ -1,45 +0,0 @@
-{
-  "$ref": "#/definitions/AffiliationSearchAnswer",
-  "definitions": {
-    "AffiliationSearchAnswer": {
-      "type": "object",
-      "properties": {
-        "type": {
-          "type": "string",
-          "const": "affiliationSearch"
-        },
-        "meta": {
-          "type": "object",
-          "properties": {
-            "schemaVersion": {
-              "type": "string",
-              "default": "1.0"
-            }
-          },
-          "additionalProperties": false,
-          "default": {}
-        },
-        "answer": {
-          "type": "object",
-          "properties": {
-            "affiliationId": {
-              "type": "string",
-              "default": ""
-            },
-            "affiliationName": {
-              "type": "string",
-              "default": ""
-            }
-          },
-          "additionalProperties": false,
-          "default": {}
-        }
-      },
-      "required": [
-        "type"
-      ],
-      "additionalProperties": false
-    }
-  },
-  "$schema": "http://json-schema.org/draft-07/schema#"
-}

package/dist/schemas/affiliationSearchQuestion.schema.json

@@ -1,140 +0,0 @@
-{
-  "$ref": "#/definitions/AffiliationSearchQuestion",
-  "definitions": {
-    "AffiliationSearchQuestion": {
-      "type": "object",
-      "properties": {
-        "type": {
-          "type": "string",
-          "const": "affiliationSearch"
-        },
-        "attributes": {
-          "type": "object",
-          "properties": {
-            "label": {
-              "type": "string"
-            },
-            "help": {
-              "type": "string"
-            },
-            "labelTranslationKey": {
-              "type": "string"
-            }
-          },
-          "additionalProperties": false,
-          "default": {}
-        },
-        "meta": {
-          "type": "object",
-          "properties": {
-            "schemaVersion": {
-              "type": "string",
-              "default": "1.0"
-            },
-            "title": {
-              "type": "string"
-            },
-            "usageDescription": {
-              "type": "string"
-            }
-          },
-          "additionalProperties": false,
-          "default": {}
-        },
-        "graphQL": {
-          "type": "object",
-          "properties": {
-            "displayFields": {
-              "type": "array",
-              "items": {
-                "type": "object",
-                "properties": {
-                  "propertyName": {
-                    "type": "string",
-                    "const": "displayName",
-                    "default": "displayName"
-                  },
-                  "label": {
-                    "type": "string",
-                    "default": "Institution"
-                  },
-                  "labelTranslationKey": {
-                    "type": "string",
-                    "default": "SignupPage.institution"
-                  }
-                },
-                "additionalProperties": false
-              },
-              "default": [
-                {}
-              ]
-            },
-            "localQueryId": {
-              "type": "string"
-            },
-            "query": {
-              "type": "string",
-              "const": "query Affiliations($name: String!){ affiliations(name: $name) { totalCount nextCursor items { id displayName uri } } }",
-              "default": "query Affiliations($name: String!){ affiliations(name: $name) { totalCount nextCursor items { id displayName uri } } }"
-            },
-            "responseField": {
-              "type": "string",
-              "const": "affiliations.items",
-              "default": "affiliations.items"
-            },
-            "variables": {
-              "type": "array",
-              "items": {
-                "type": "object",
-                "properties": {
-                  "name": {
-                    "type": "string",
-                    "const": "name",
-                    "default": "name"
-                  },
-                  "type": {
-                    "type": "string",
-                    "default": "string"
-                  },
-                  "label": {
-                    "type": "string",
-                    "default": "Search for your institution"
-                  },
-                  "minLength": {
-                    "type": "number",
-                    "const": 3,
-                    "default": 3
-                  },
-                  "labelTranslationKey": {
-                    "type": "string",
-                    "default": "SignupPage.institutionHelp"
-                  }
-                },
-                "additionalProperties": false
-              },
-              "default": [
-                {}
-              ]
-            },
-            "queryId": {
-              "type": "string",
-              "default": "useAffiliationsQuery"
-            },
-            "answerField": {
-              "type": "string",
-              "const": "uri",
-              "default": "uri"
-            }
-          },
-          "additionalProperties": false,
-          "default": {}
-        }
-      },
-      "required": [
-        "type"
-      ],
-      "additionalProperties": false
-    }
-  },
-  "$schema": "http://json-schema.org/draft-07/schema#"
-}