@dmptool/types 2.1.0 → 2.2.0

package/README.md

@@ -215,7 +215,73 @@ To just generate JSON schemas from the Zod schemas: `npm run generate`
 
 To build the Types, Zod schemas and JSON schemas all at once: `npm run build`
 
-To publish changes:
+### Pre-testing changes from dmptool-types in the backend or frontend
+
+It's possible to test changes so you don't have to publish the new version
+of  `@dmptool/types` to npm until you know the changes are working as expected. You
+may also fix tests or make other changes to the backend or frontend to use the new types
+schema if it causes breaking changes.
+
+in the existing package.json it looks like the following (most of the file omitted):
+
+```json
+{
+  "dependencies": {
+    "@dmptool/types": "2.0.0",
+  }
+}
+```
+
+To test frontend or backed locally with new types, change the version to point to the
+GitHub repo instead. You should have committed and pushed your changes to a branch in
+the dmptool-types repo before doing this.
+
+While you can put a branch name after the `#` here, it's better to use a specific
+commit hash since it makes it more clear for caching algorithms that code has changed
+(while a branch name may stay the same, even with changes to the branch). You can
+see the latest commit hash by doing `git log -1` in the dmptool-types repo
+(be sure that commit is on github!).
+
+Example (most of the file omitted):
+
+```json
+{
+  "dependencies": {
+    "@dmptool/types": "github:CDLUC3/dmptool-types#3804909b252dcf3af4487438ed9321d6a06decd1",
+  }
+}
+```
+
+After changing you need to run `npm install` again to update the dependency and probably need
+to stop docker and do `docker compose up` again (if you're using docker for local development).
+
+This may also help you decide how to set SEMVER version number as a MAJOR, MINOR or PATCH change
+when you go to publish the types package to NPM depending on if breaking existing code.
+
+After you've tested your changes and are happy with them, be sure to change the package.json
+`@dmptool/types` back to the previous npm repository and version. After you've published
+the types to NPM (see section below), you can then update the backend and frontend package.json files
+to use the new version from NPM.
+
+It's tricky to manage these changes since they potentially may require changes to
+three different repositories in parallel since likely the types changes will at
+least require version number changes to be published to NPM and then the frontend
+and backend will need to update their dependencies to use the new version of the
+types package, also.
+
+Be careful with testing locally since if other people are working in parallel with
+types or other backend/frontend changes then the compatibility may change if you're pulling
+latest changes in only some of the repos from upstream, but not others.
+
+Problems may not be obvious or easy to figure out when things get out of sync and
+you can waste a lot of time trying to figure out why something isn't working.
+One way to keep things in sync is to create parallel feature branches on all three
+repos when starting the work,so the changes stay the same and can be tested together
+and act like an atomic unit rather than some parts drifting out of sync. If you pull
+in latest changes from upstream on one repo, be sure to do it on all three repos.
+
+
+### To publish changes:
 - Increment the `version` in `package.json`
 - Run `npm login` and login to you npm account
 - Run `npm publish --access public`
@@ -242,3 +308,6 @@ latest: 1.0.0
 
 published 6 minutes ago by npm-user-name <email-address>
 ```
+
+After publishing changes you'll need to update the `@dmptool/types` dependency in both the
+backend and frontend repos to use the new version number and run `npm install` again.

package/dist/answers/__tests__/defaults.spec.js

@@ -2,6 +2,44 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const questions_1 = require("../../questions");
 const index_1 = require("../index");
+// Helper to only assert `comment` when both actual and expected include it anywhere in the structure.
+function normalizeForCommentCheck(actualInput, expectedInput) {
+    const actual = JSON.parse(JSON.stringify(actualInput));
+    const expected = JSON.parse(JSON.stringify(expectedInput));
+    const isPlainObject = (v) => v !== null && typeof v === 'object' && !Array.isArray(v);
+    function prune(a, e) {
+        if (Array.isArray(e) && Array.isArray(a)) {
+            const aArr = a;
+            const eArr = e;
+            const len = Math.min(aArr.length, eArr.length);
+            for (let i = 0; i < len; i++)
+                prune(aArr[i], eArr[i]);
+            return;
+        }
+        if (isPlainObject(e) && isPlainObject(a)) {
+            const aObj = a;
+            const eObj = e;
+            // For keys in expected: if it's 'comment' but actual doesn't have it, remove from expected
+            for (const key of Object.keys(eObj)) {
+                if (key === 'comment') {
+                    if (!Object.prototype.hasOwnProperty.call(aObj, 'comment'))
+                        delete eObj['comment'];
+                }
+                else if (Object.prototype.hasOwnProperty.call(aObj, key)) {
+                    prune(aObj[key], eObj[key]);
+                }
+            }
+            // For keys only in actual: if it's 'comment' but expected doesn't have it, remove from actual
+            for (const key of Object.keys(aObj)) {
+                if (key === 'comment' && !Object.prototype.hasOwnProperty.call(eObj, 'comment')) {
+                    delete aObj['comment'];
+                }
+            }
+        }
+    }
+    prune(actual, expected);
+    return { actual, expected };
+}
 describe('Get question answer defaultJSON', () => {
     it('returns the expected default affiliationSearch', () => {
         const expected = {
@@ -12,7 +50,8 @@ describe('Get question answer defaultJSON', () => {
             },
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultAffiliationSearchAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultAffiliationSearchAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default boolean', () => {
         const expected = {
@@ -20,7 +59,8 @@ describe('Get question answer defaultJSON', () => {
             answer: false,
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultBooleanAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultBooleanAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default checkBoxes', () => {
         const expected = {
@@ -28,7 +68,8 @@ describe('Get question answer defaultJSON', () => {
             answer: [],
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultCheckboxesAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultCheckboxesAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default currency', () => {
         const expected = {
@@ -36,7 +77,8 @@ describe('Get question answer defaultJSON', () => {
             answer: 0,
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultCurrencyAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultCurrencyAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default date', () => {
         const expected = {
@@ -44,7 +86,8 @@ describe('Get question answer defaultJSON', () => {
             answer: "",
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultDateAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultDateAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default dateRange', () => {
         const expected = {
@@ -55,7 +98,8 @@ describe('Get question answer defaultJSON', () => {
             },
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultDateRangeAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultDateRangeAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default email', () => {
         const expected = {
@@ -63,7 +107,8 @@ describe('Get question answer defaultJSON', () => {
             answer: "",
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultEmailAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultEmailAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default licenseSearch', () => {
         const expected = {
@@ -74,7 +119,8 @@ describe('Get question answer defaultJSON', () => {
                 }],
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultLicenseSearchAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultLicenseSearchAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default metadataStandardSearch', () => {
         const expected = {
@@ -85,7 +131,8 @@ describe('Get question answer defaultJSON', () => {
                 }],
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultMetadataStandardSearchAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultMetadataStandardSearchAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default multiselectBox', () => {
         const expected = {
@@ -93,7 +140,8 @@ describe('Get question answer defaultJSON', () => {
             answer: [],
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultMultiselectBoxAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultMultiselectBoxAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default number', () => {
         const expected = {
@@ -101,7 +149,8 @@ describe('Get question answer defaultJSON', () => {
             answer: 0,
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultNumberAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultNumberAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default numberRange', () => {
         const expected = {
@@ -112,7 +161,8 @@ describe('Get question answer defaultJSON', () => {
             },
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultNumberRangeAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultNumberRangeAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default numberWithContext', () => {
         const expected = {
@@ -123,7 +173,8 @@ describe('Get question answer defaultJSON', () => {
             },
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultNumberWithContextAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultNumberWithContextAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default radioButtons', () => {
         const expected = {
@@ -131,7 +182,8 @@ describe('Get question answer defaultJSON', () => {
             answer: "",
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultRadioButtonsAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultRadioButtonsAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default repositorySearch', () => {
         const expected = {
@@ -142,7 +194,8 @@ describe('Get question answer defaultJSON', () => {
                 }],
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultRepositorySearchAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultRepositorySearchAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default researchOutputTable', () => {
         const expected = {
@@ -164,7 +217,8 @@ describe('Get question answer defaultJSON', () => {
                 }],
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultResearchOutputTableAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultResearchOutputTableAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default selectBox', () => {
         const expected = {
@@ -172,7 +226,8 @@ describe('Get question answer defaultJSON', () => {
             answer: "",
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultSelectBoxAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultSelectBoxAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default table', () => {
         const expected = {
@@ -187,7 +242,8 @@ describe('Get question answer defaultJSON', () => {
                 }],
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultTableAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultTableAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default text', () => {
         const expected = {
@@ -195,7 +251,8 @@ describe('Get question answer defaultJSON', () => {
             answer: "",
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultTextAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultTextAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default textArea', () => {
         const expected = {
@@ -203,7 +260,8 @@ describe('Get question answer defaultJSON', () => {
             answer: "",
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultTextAreaAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultTextAreaAnswer, expected);
+        expect(actual).toEqual(exp);
     });
     it('returns the expected default url', () => {
         const expected = {
@@ -211,6 +269,7 @@ describe('Get question answer defaultJSON', () => {
             answer: "",
             meta: { schemaVersion: questions_1.CURRENT_SCHEMA_VERSION },
         };
-        expect(index_1.DefaultURLAnswer).toEqual(expected);
+        const { actual, expected: exp } = normalizeForCommentCheck(index_1.DefaultURLAnswer, expected);
+        expect(actual).toEqual(exp);
     });
 });

package/dist/answers/answer.d.ts

@@ -26,12 +26,14 @@ export declare const AnswerSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>;
+    comment: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const DefaultAnswer: {
     type: "number" | "boolean" | "affiliationSearch" | "checkBoxes" | "currency" | "date" | "dateRange" | "email" | "licenseSearch" | "metadataStandardSearch" | "multiselectBox" | "numberRange" | "numberWithContext" | "radioButtons" | "repositorySearch" | "researchOutputTable" | "selectBox" | "table" | "text" | "textArea" | "url";
     meta: {
         schemaVersion: string;
     };
+    comment?: string | undefined;
 };
 export type AnswerType = z.infer<typeof AnswerSchema>;
 export declare const AnswerJSONSchema: z.core.JSONSchema.JSONSchema;

package/dist/answers/answer.js

@@ -8,11 +8,13 @@ exports.AnswerSchema = zod_1.z.object({
     type: questions_1.QuestionFormatsEnum, // The type of answer
     meta: zod_1.z.object({
         schemaVersion: zod_1.z.string().default(questions_1.CURRENT_SCHEMA_VERSION), // The schema version of the answer
-    })
+    }),
+    comment: zod_1.z.string().optional() // Optional comment associated with the answer
 });
 exports.DefaultAnswer = exports.AnswerSchema.parse({
     type: 'textArea',
     answer: "",
-    meta: questions_1.DefaultMeta
+    meta: questions_1.DefaultMeta,
+    comment: ""
 });
 exports.AnswerJSONSchema = zod_1.z.toJSONSchema(exports.AnswerSchema);

package/dist/answers/dateAnswers.d.ts

@@ -5,6 +5,7 @@ export declare const DateAnswerSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>;
+    comment: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const DefaultDateAnswer: {
     type: "date";
@@ -12,6 +13,7 @@ export declare const DefaultDateAnswer: {
     meta: {
         schemaVersion: string;
     };
+    comment?: string | undefined;
 };
 export declare const DateRangeAnswerSchema: z.ZodObject<{
     type: z.ZodLiteral<"dateRange">;
@@ -22,6 +24,7 @@ export declare const DateRangeAnswerSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>;
+    comment: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const DefaultDateRangeAnswer: {
     type: "dateRange";
@@ -32,6 +35,7 @@ export declare const DefaultDateRangeAnswer: {
     meta: {
         schemaVersion: string;
     };
+    comment?: string | undefined;
 };
 export type DateAnswerType = z.infer<typeof DateAnswerSchema>;
 export type DateRangeAnswerType = z.infer<typeof DateRangeAnswerSchema>;

package/dist/answers/graphQLAnswers.d.ts

@@ -8,6 +8,7 @@ export declare const AffiliationSearchAnswerSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>;
+    comment: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const DefaultAffiliationSearchAnswer: {
     type: "affiliationSearch";
@@ -18,6 +19,7 @@ export declare const DefaultAffiliationSearchAnswer: {
     meta: {
         schemaVersion: string;
     };
+    comment?: string | undefined;
 };
 export declare const LicenseSearchAnswerSchema: z.ZodObject<{
     type: z.ZodLiteral<"licenseSearch">;
@@ -28,6 +30,7 @@ export declare const LicenseSearchAnswerSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>;
+    comment: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const DefaultLicenseSearchAnswer: {
     type: "licenseSearch";
@@ -38,6 +41,7 @@ export declare const DefaultLicenseSearchAnswer: {
     meta: {
         schemaVersion: string;
     };
+    comment?: string | undefined;
 };
 export declare const MetadataStandardSearchAnswerSchema: z.ZodObject<{
     type: z.ZodLiteral<"metadataStandardSearch">;
@@ -48,6 +52,7 @@ export declare const MetadataStandardSearchAnswerSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>;
+    comment: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const DefaultMetadataStandardSearchAnswer: {
     type: "metadataStandardSearch";
@@ -58,6 +63,7 @@ export declare const DefaultMetadataStandardSearchAnswer: {
     meta: {
         schemaVersion: string;
     };
+    comment?: string | undefined;
 };
 export declare const RepositorySearchAnswerSchema: z.ZodObject<{
     type: z.ZodLiteral<"repositorySearch">;
@@ -68,6 +74,7 @@ export declare const RepositorySearchAnswerSchema: z.ZodObject<{
     meta: z.ZodObject<{
         schemaVersion: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>;
+    comment: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare const DefaultRepositorySearchAnswer: {
     type: "repositorySearch";
@@ -78,6 +85,7 @@ export declare const DefaultRepositorySearchAnswer: {
     meta: {
         schemaVersion: string;
     };
+    comment?: string | undefined;
 };
 export type AffiliationSearchAnswerType = z.infer<typeof AffiliationSearchAnswerSchema>;
 export type LicenseSearchAnswerType = z.infer<typeof LicenseSearchAnswerSchema>;