@dmptool/types 2.2.0 → 2.3.0

package/dist/dmp/extension.js

@@ -20,133 +20,79 @@ const researchFacilityTypes = [
     'observatory',
     'other',
 ];
-// Relation types are derived from the DataCite schema
-const relationTypes = [
-    "is_cited_by",
-    "cites",
-    "is_supplement_to",
-    "is_supplemented_by",
-    "is_continued_by",
-    "continues",
-    "is_described_by",
-    "describes",
-    "has_metadata",
-    "is_metadata_for",
-    "has_version",
-    "is_version_of",
-    "is_new_version_of",
-    "is_previous_version_of",
-    "is_part_of",
-    "has_part",
-    "is_published_in",
-    "is_referenced_by",
-    "references",
-    "is_documented_by",
-    "documents",
-    "is_compiled_by",
-    "compiles",
-    "is_variant_form_of",
-    "is_original_form_of",
-    "is_identical_to",
-    "is_reviewed_by",
-    "reviews",
-    "is_derived_from",
-    "is_source_of",
-    "is_required_by",
-    "requires",
-    "obsoletes",
-    "is_obsoleted_by",
-    "is_collected_by",
-    "collects",
-    "is_translation_of",
-    "has_translation"
+// The possible statuses of a DMP
+const statusTypes = [
+    'archived',
+    'draft',
+    'complete',
 ];
-// Work types are derived from the DataCite schema
-const workTypes = [
-    "audiovisual",
-    "book",
-    "book_chapter",
-    "collection",
-    "computational_notebook",
-    "conference_paper",
-    "conference_proceeding",
-    "data_paper",
-    "dataset",
-    "dissertation",
-    "event",
-    "image",
-    "instrument",
-    "interactive_resource",
-    "journal",
-    "journal_article",
-    "model",
-    "output_management_plan",
-    "peer_review",
-    "physical_object",
-    "preprint",
-    "project",
-    "report",
-    "service",
-    "software",
-    "sound",
-    "standard",
-    "study_registration",
-    "text",
-    "workflow",
-    "other"
+const identifierTypes = [
+    'ark',
+    'doi',
+    'handle',
+    'ror',
+    'url',
+    'other',
 ];
 const ResearchDomainSchema = zod_1.z.object({
     // The human-readable name for the research domain
     name: zod_1.z.string(),
     // The identifier for the research domain
     research_domain_identifier: zod_1.z.object({
-        identifier: zod_1.z.string().optional(),
-        type: zod_1.z.enum(['ark', 'doi', 'handle', 'url', 'other']).default('url')
-    }),
-});
-const RelatedIdentifierSchema = zod_1.z.object({
-    // The description of how the DMP is related to the work (e.g. the DMP "cites" the work)
-    descriptor: zod_1.z.enum(relationTypes).default('cites'),
-    // The identifier of the work
-    identifier: zod_1.z.string(),
-    // The type of identifier
-    type: zod_1.z.enum(['ark', 'doi', 'handle', 'url']).default('url'),
-    // The type of the work
-    work_type: zod_1.z.enum(workTypes).default('dataset'),
+        identifier: zod_1.z.string(),
+        type: zod_1.z.enum(identifierTypes)
+    }).optional(),
 });
 const ResearchFacilitySchema = zod_1.z.object({
     // The human-readable name of the research facility
     name: zod_1.z.string(),
     // The facility type
-    type: zod_1.z.enum(researchFacilityTypes).default('other'),
+    type: zod_1.z.enum(researchFacilityTypes),
     // The identifier for the research facility
     research_facility_identifier: zod_1.z.object({
         identifier: zod_1.z.string(),
-        type: zod_1.z.enum(['ark', 'doi', 'handle', 'url', 'other']).default('url')
-    }),
+        type: zod_1.z.enum(identifierTypes)
+    }).optional(),
 });
 const FundingOpportunitySchema = zod_1.z.object({
     // The id of the project this opportunity maps to
     project_id: zod_1.z.object({
         identifier: zod_1.z.string(),
-        type: zod_1.z.enum(['ark', 'doi', 'handle', 'url', 'other']).default('other')
+        type: zod_1.z.enum(identifierTypes)
     }),
     // The id of the funding this opportunity maps to within the project
     funder_id: zod_1.z.object({
         identifier: zod_1.z.string(),
-        type: zod_1.z.enum(['ror', 'url', 'other']).default('ror')
+        type: zod_1.z.enum(identifierTypes)
     }),
     // The opportunity id
     opportunity_identifier: zod_1.z.object({
         identifier: zod_1.z.string(),
-        type: zod_1.z.enum(['ark', 'doi', 'handle', 'url', 'other']).default('url')
+        type: zod_1.z.enum(identifierTypes)
+    })
+});
+const FundingProjectNumberSchema = zod_1.z.object({
+    // The id of the project this opportunity maps to
+    project_id: zod_1.z.object({
+        identifier: zod_1.z.string(),
+        type: zod_1.z.enum(identifierTypes)
+    }),
+    // The id of the funding this opportunity maps to within the project
+    funder_id: zod_1.z.object({
+        identifier: zod_1.z.string(),
+        type: zod_1.z.enum(identifierTypes)
+    }),
+    // The funder's identifier for this project
+    project_identifier: zod_1.z.object({
+        identifier: zod_1.z.string(),
+        type: zod_1.z.enum(identifierTypes)
     })
 });
 const VersionSchema = zod_1.z.object({
     // URL to fetch the historical version of the DMP
     access_url: zod_1.z.string(),
     // The date of the version
-    version_date: zod_1.z.iso.datetime(),
+    version: zod_1.z.iso.datetime(),
 });
 const NarrativeAnswerSchema = zod_1.z.object({
     id: zod_1.z.number(),
@@ -193,41 +139,41 @@ const DefaultNarrativeTemplate = NarrativeTemplateSchema.parse({
     title: 'Undefined template',
     section: [DefaultSection]
 });
-// URLs to fetch the narrative as a document other than JSON
-const NarrativeURLsSchema = zod_1.z.object({
-    csv: zod_1.z.string().optional(),
-    docx: zod_1.z.string().optional(),
-    html: zod_1.z.string().optional(),
-    pdf: zod_1.z.string().optional(),
-});
 const NarrativeSchema = zod_1.z.object({
-    download_urls: NarrativeURLsSchema.optional(),
+    download_url: zod_1.z.string().optional(),
     template: NarrativeTemplateSchema.optional(),
 });
 exports.DefaultNarrative = NarrativeSchema.parse({
     template: DefaultNarrativeTemplate
 });
 exports.ExtensionSchema = zod_1.z.object({
+    // TODO: Would eventually be nice to set this to the RDA_COMMON_STANDARD_VERSION
+    //       when Zod's toJSONSchema allows it
+    rda_schema_version: zod_1.z.string().default("1.2"),
     // The name of the system that owns this record
     provenance: zod_1.z.string(),
+    // The current status of the DMP
+    status: zod_1.z.enum(statusTypes).default('draft'),
     // The visibility setting for the DMP
     privacy: zod_1.z.enum(visibilityTypes).default('private'),
     // Whether the DMP is featured on the public plans page of the DMP Tool website
     featured: zod_1.z.enum(['yes', 'no']).default('no'),
     // The date the DMP Id was registered as a DOI with EZID/DataCite
     registered: zod_1.z.iso.datetime().optional(),
+    // The date the DMP's DOI was tomb-stoned
+    tombstoned: zod_1.z.iso.datetime().optional(),
     // The narrative content of the DMP expressed as a JSON object
     narrative: NarrativeSchema.optional(),
     // The research domain of the project/DMP
     research_domain: ResearchDomainSchema.optional(),
-    // Other works related to the DMP
-    related_identifier: zod_1.z.array(RelatedIdentifierSchema).optional(),
     // Research facilities used to collect or process data
     research_facility: zod_1.z.array(ResearchFacilitySchema).optional(),
     // Historical versions of the DMP
     version: zod_1.z.array(VersionSchema).optional(),
     // Funding opportunity / call for grant submissions related to the funding
     funding_opportunity: zod_1.z.array(FundingOpportunitySchema).optional(),
+    // Funding project number (defined by the funder)
+    funding_project: zod_1.z.array(FundingProjectNumberSchema).optional(),
 });
 exports.DefaultExtensionSchema = exports.ExtensionSchema.parse({
     provenance: 'your-application',