@postxl/schema 0.0.2

package/dist/samples/ring.schema.json

@@ -0,0 +1,879 @@
+{
+    "name": "PostXL ring",
+    "slug": "ring",
+    "description": "Internal management tool for PostXL",
+    "version": "0.0.1",
+    "schemas": ["PXL", "Data"],
+    "defaultSchema": "Data",
+    "systemUser": { "name": "System", "email": "system@postxl.com" },
+    "standardModels": ["Action", "ActionOperation", "User", "File"],
+    "models": [
+        {
+            "name": "Industry",
+            "description": "An industry",
+            "fields": [
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the industry."
+                }
+            ],
+            "seed": [{ "id": "Pharma", "name": "Pharma" }]
+        },
+        {
+            "name": "CorporateFunction",
+            "description": "A corporate function",
+            "fields": [
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the corporate function."
+                }
+            ],
+            "seed": [
+                { "id": "Benchmarking", "name": "Benchmarking" },
+                { "id": "Business Development", "name": "Business Development" },
+                { "id": "Controlling", "name": "Controlling" },
+                { "id": "Finance", "name": "Finance" },
+                { "id": "HR", "name": "HR" },
+                { "id": "IT", "name": "IT" },
+                { "id": "Legal", "name": "Legal" },
+                { "id": "Marketing", "name": "Marketing" },
+                { "id": "Operations", "name": "Operations" },
+                { "id": "Procurement", "name": "Procurement" },
+                { "id": "Research", "name": "Research" },
+                { "id": "Sales", "name": "Sales" },
+                { "id": "Supply Chain", "name": "Supply Chain" }
+            ]
+        },
+        {
+            "name": "DemoProject",
+            "description": "A demo project that shows a use case of PostXL.",
+            "fields": [
+                {
+                    "name": "industryId",
+                    "type": "Industry?",
+                    "label": "IndustryId",
+                    "description": "The industry of the demo project."
+                },
+                {
+                    "name": "corporateFunctionId",
+                    "type": "CorporateFunction?",
+                    "label": "CorporateFunctionId",
+                    "description": "The corporate function of the demo project."
+                },
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the demo project."
+                },
+                {
+                    "name": "description",
+                    "type": "String?",
+                    "label": "Description",
+                    "description": "The description of the demo project."
+                },
+                {
+                    "name": "status",
+                    "type": "DemoProjectStatus",
+                    "label": "Status",
+                    "description": "The status of the demo project."
+                },
+                {
+                    "name": "link",
+                    "type": "String?",
+                    "label": "Link",
+                    "description": "The link to the demo project."
+                },
+                {
+                    "name": "componentsUsed",
+                    "type": "String?",
+                    "label": "ComponentsUsed",
+                    "description": "A comma separated list of the components used in the demo project.\n\nTODO: This should be a relation to a Component model."
+                },
+                {
+                    "name": "cssConfiguration",
+                    "type": "String?",
+                    "label": "CssConfiguration",
+                    "description": "The full configuration as created by the Ring Configuration Editor."
+                },
+                {
+                    "name": "schema",
+                    "type": "String?",
+                    "label": "Schema",
+                    "description": "The PostXL Prisma schema"
+                }
+            ],
+            "seed": [
+                {
+                    "id": "DemoProject1",
+                    "industryId": null,
+                    "corporateFunctionId": "HR",
+                    "name": "Training Database",
+                    "description": "A database for training purposes",
+                    "status": "Idea",
+                    "link": null,
+                    "componentsUsed": null,
+                    "cssConfiguration": null,
+                    "schema": null
+                },
+                {
+                    "id": "DemoProject2",
+                    "industryId": "Pharma",
+                    "corporateFunctionId": null,
+                    "name": "International Revenue Pricing",
+                    "description": "A tool helping to identify the best international launch sequence for new drugs",
+                    "status": "Idea",
+                    "link": null,
+                    "componentsUsed": "Map, Grid",
+                    "cssConfiguration": null,
+                    "schema": null
+                },
+                {
+                    "id": "DemoProject3",
+                    "industryId": null,
+                    "corporateFunctionId": null,
+                    "name": "CRM",
+                    "description": "A CRM system",
+                    "status": "WorkInProgress",
+                    "link": null,
+                    "componentsUsed": null,
+                    "cssConfiguration": null,
+                    "schema": null
+                },
+                {
+                    "id": "DemoProject4",
+                    "industryId": "Pharma",
+                    "corporateFunctionId": null,
+                    "name": "Subex",
+                    "description": "Submission Excellence for new drug approval",
+                    "status": "Completed",
+                    "link": "https://subex.postxl.com",
+                    "componentsUsed": "Gantt",
+                    "cssConfiguration": null,
+                    "schema": null
+                }
+            ]
+        },
+        {
+            "name": "Project",
+            "description": "A agreed Project.",
+            "fields": [
+                {
+                    "name": "businessLeadId",
+                    "type": "TeamMember?",
+                    "prismaRelationFieldName": "BusinessLead",
+                    "label": "Business lead",
+                    "description": "PostXL Business Owner/contact for the project."
+                },
+                {
+                    "name": "technicalLeadId",
+                    "type": "TeamMember?",
+                    "prismaRelationFieldName": "ProjectTechnicalLead",
+                    "label": "Technical lead",
+                    "description": "PostXL Technical Owner/contact for the project."
+                },
+                {
+                    "name": "industryId",
+                    "type": "Industry?",
+                    "label": "IndustryId",
+                    "description": "The industry of the project."
+                },
+                {
+                    "name": "corporateFunctionId",
+                    "type": "CorporateFunction?",
+                    "label": "CorporateFunctionId",
+                    "description": "The corporate function of the project."
+                },
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the project."
+                },
+                {
+                    "name": "description",
+                    "type": "String?",
+                    "label": "Description",
+                    "description": "The description of the project."
+                },
+                {
+                    "name": "clientId",
+                    "type": "Client",
+                    "prismaRelationFieldName": "client",
+                    "label": "ClientId",
+                    "description": "The client of the project."
+                },
+                {
+                    "name": "mainContactId",
+                    "type": "Contact",
+                    "prismaRelationFieldName": "mainContact",
+                    "label": "MainContactId",
+                    "description": "Who is the main contact of the client for the project."
+                },
+                {
+                    "name": "intermediaryClientId",
+                    "type": "Client?",
+                    "prismaRelationFieldName": "intermediaryClient",
+                    "label": "IntermediaryClientId",
+                    "description": "Some projects are invoiced via an intermediary client."
+                },
+                {
+                    "name": "intermediaryClientContactId",
+                    "type": "Contact?",
+                    "prismaRelationFieldName": "intermediaryClientContact",
+                    "label": "IntermediaryClientContactId",
+                    "description": "The contact of the intermediary client for the project."
+                }
+            ],
+            "seed": [
+                {
+                    "id": "Project-es-crcaim",
+                    "clientId": "Client_ES",
+                    "mainContactId": null,
+                    "businessLeadId": "peter",
+                    "technicalLeadId": "chris",
+                    "industryId": "Pharma",
+                    "corporateFunctionId": "Sales",
+                    "name": "CRCAIM",
+                    "description": "Colorectal Cancer AIM Microsimulation"
+                },
+                {
+                    "id": "Project-mca",
+                    "clientId": "Client_McKinsey",
+                    "mainContactId": null,
+                    "businessLeadId": "johan",
+                    "technicalLeadId": "peter",
+                    "industryId": "Pharma",
+                    "corporateFunctionId": "Operations",
+                    "name": "MCA",
+                    "description": "Modular Content Accelerator"
+                },
+                {
+                    "id": "Project-mckinsey-subex",
+                    "clientId": "Client_McKinsey",
+                    "mainContactId": null,
+                    "businessLeadId": "peter",
+                    "technicalLeadId": "peter",
+                    "industryId": "Pharma",
+                    "corporateFunctionId": "Research",
+                    "name": "Subex",
+                    "description": "Submission Excellence"
+                }
+            ]
+        },
+        {
+            "name": "Currency",
+            "description": "A currency",
+            "fields": [
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the currency."
+                },
+                {
+                    "name": "code",
+                    "type": "String",
+                    "label": "Code"
+                },
+                {
+                    "name": "fxSymbol",
+                    "type": "String",
+                    "label": "FxSymbol",
+                    "description": "The symbol of the currency."
+                }
+            ],
+            "seed": [
+                {
+                    "id": "EUR",
+                    "name": "Euro",
+                    "code": "EUR",
+                    "fxSymbol": "€"
+                },
+                {
+                    "id": "USD",
+                    "name": "US Dollar",
+                    "code": "USD",
+                    "fxSymbol": "$"
+                },
+                {
+                    "id": "GBP",
+                    "name": "British Pound",
+                    "code": "GBP",
+                    "fxSymbol": "£"
+                },
+                {
+                    "id": "DKK",
+                    "name": "Danish Krone",
+                    "code": "DKK",
+                    "fxSymbol": "kr"
+                }
+            ]
+        },
+        {
+            "name": "ProjectPhase",
+            "description": "A phase of a project.",
+            "fields": [
+                {
+                    "name": "projectId",
+                    "type": "String",
+                    "label": "ProjectId"
+                },
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name"
+                },
+                {
+                    "name": "status",
+                    "type": "ProjectPhaseStatus",
+                    "label": "Status",
+                    "description": "The status of the project phase."
+                },
+                {
+                    "name": "scope",
+                    "type": "String",
+                    "label": "Scope",
+                    "description": "The description of the project phase's scope."
+                },
+                {
+                    "name": "commercialSummary",
+                    "type": "String",
+                    "label": "CommercialSummary",
+                    "description": "A summary of the commercial agreement for the project phase."
+                },
+                {
+                    "name": "contractLinks",
+                    "type": "String?",
+                    "label": "ContractLinks",
+                    "description": "Comma-separated list of links to contracts, invoices, etc."
+                },
+                {
+                    "name": "currencyId",
+                    "type": "Currency",
+                    "label": "CurrencyId",
+                    "description": "The currency agreed for the project phase."
+                },
+                {
+                    "name": "startDate",
+                    "type": "DateTime?",
+                    "label": "StartDate",
+                    "description": "The (expected) start date of the project phase."
+                },
+                {
+                    "name": "endDate",
+                    "type": "DateTime?",
+                    "label": "EndDate",
+                    "description": "The (expected) end date of the project phase."
+                }
+            ]
+        },
+        {
+            "name": "InvoiceStatus",
+            "description": "Status an Invoice can have.",
+            "fields": [
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the invoice status."
+                },
+                {
+                    "name": "paymentProbability",
+                    "type": "Float",
+                    "label": "PaymentProbability",
+                    "description": "The probability of payment."
+                }
+            ],
+            "seed": [
+                {
+                    "id": "Invoice_Paid",
+                    "name": "Paid",
+                    "paymentProbability": 1
+                },
+                {
+                    "id": "Invoice_Issued",
+                    "name": "Issued",
+                    "paymentProbability": 0.95
+                },
+                {
+                    "id": "Invoice_WorkInProgress",
+                    "name": "Work in progress",
+                    "paymentProbability": 0.9
+                },
+                {
+                    "id": "Invoice_Agreed",
+                    "name": "Agreed",
+                    "paymentProbability": 0.8
+                },
+                {
+                    "id": "Invoice_OngoingMaintenance",
+                    "name": "Ongoing maintenance",
+                    "paymentProbability": 0.95
+                },
+                {
+                    "id": "Invoice_ToBeInvoicedLater",
+                    "name": "To be invoiced later",
+                    "paymentProbability": 0.8
+                },
+                {
+                    "id": "Invoice_InNegotiation",
+                    "name": "In negotiation",
+                    "paymentProbability": 0.5
+                },
+                {
+                    "id": "Invoice_Cancelled",
+                    "name": "Cancelled",
+                    "paymentProbability": 0
+                }
+            ]
+        },
+        {
+            "name": "Invoice",
+            "description": "An invoice for a project phase or other efforts.",
+            "fields": [
+                {
+                    "name": "recipientId",
+                    "type": "Contact",
+                    "label": "RecipientId",
+                    "description": "The recipient of the invoice."
+                },
+                {
+                    "name": "projectPhaseId",
+                    "type": "ProjectPhase?",
+                    "label": "ProjectPhaseId",
+                    "description": "The project phase the invoice is for."
+                },
+                {
+                    "name": "invoiceStatusId",
+                    "type": "InvoiceStatus",
+                    "label": "InvoiceStatusId",
+                    "description": "The status of the invoice."
+                },
+                {
+                    "name": "dateIssued",
+                    "type": "DateTime?",
+                    "label": "DateIssued",
+                    "description": "The date the invoice was issued."
+                },
+                {
+                    "name": "dateExpectedPayment",
+                    "type": "DateTime?",
+                    "label": "DateExpectedPayment",
+                    "description": "The date the invoice is expected to be paid."
+                },
+                {
+                    "name": "datePaid",
+                    "type": "DateTime?",
+                    "label": "DatePaid",
+                    "description": "The date the invoice was paid."
+                },
+                {
+                    "name": "issuedById",
+                    "type": "TeamMember",
+                    "label": "IssuedById",
+                    "description": "The user that issued the invoice."
+                },
+                {
+                    "name": "currencyId",
+                    "type": "Currency",
+                    "label": "CurrencyId",
+                    "description": "The currency of the invoice."
+                },
+                {
+                    "name": "amountInvoicedNetFX",
+                    "type": "Float",
+                    "label": "AmountInvoicedNetFX",
+                    "description": "The net amount of the invoice in the agreed local currency."
+                },
+                {
+                    "name": "amountInvoicedGrossFX",
+                    "type": "Float",
+                    "label": "AmountInvoicedGrossFX",
+                    "description": "The gross amount of the invoice in the agreed local currency."
+                },
+                {
+                    "name": "amountInvoicedNetEUR",
+                    "type": "Float",
+                    "label": "AmountInvoicedNetEUR",
+                    "description": "The net amount of the invoice in EUR."
+                },
+                {
+                    "name": "amountInvoicedGrossEUR",
+                    "type": "Float",
+                    "label": "AmountInvoicedGrossEUR",
+                    "description": "The gross amount of the invoice in EUR."
+                },
+                {
+                    "name": "amountReceivedFX",
+                    "type": "Float",
+                    "label": "AmountReceivedFX",
+                    "description": "The amount received for the invoice in the agreed local currency."
+                },
+                {
+                    "name": "paymentProbability",
+                    "type": "Float",
+                    "label": "PaymentProbability",
+                    "description": "The probability of payment."
+                },
+                {
+                    "name": "deliveryPeriodStart",
+                    "type": "DateTime?",
+                    "label": "DeliveryPeriodStart"
+                },
+                {
+                    "name": "deliveryPeriodEnd",
+                    "type": "DateTime?",
+                    "label": "DeliveryPeriodEnd"
+                },
+                {
+                    "name": "clientReference",
+                    "type": "String?",
+                    "label": "ClientReference",
+                    "description": "The client charge code/reference/PO number."
+                },
+                {
+                    "name": "shareOfPhaseCompletion",
+                    "type": "Float?",
+                    "label": "ShareOfPhaseCompletion",
+                    "description": "Invoice represents which share of the project phase completion."
+                }
+            ]
+        },
+        {
+            "name": "Client",
+            "description": "A client/company of PostXL.",
+            "fields": [
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the client."
+                },
+                {
+                    "name": "alias",
+                    "type": "String?",
+                    "label": "Alias",
+                    "description": "Comma-separated list of client aliases."
+                },
+                {
+                    "name": "intermediaryClientId",
+                    "type": "Client?",
+                    "prismaRelationFieldName": "ClientIntermediaryClient",
+                    "label": "IntermediaryClientId",
+                    "description": "In case this client is to be invoiced via an intermediary client, this field contains the intermediary client's ID."
+                }
+            ],
+            "seed": [
+                {
+                    "id": "Client_McKinsey",
+                    "name": "McKinsey",
+                    "alias": "McKinsey & Company",
+                    "intermediaryClientId": null
+                },
+                {
+                    "id": "Client_Prohyp",
+                    "name": "Prohyp GmbH",
+                    "alias": "Interhyp",
+                    "intermediaryClientId": null
+                },
+                {
+                    "id": "Client_Inizio",
+                    "name": "Inizio Group Limited",
+                    "alias": "Evoke",
+                    "intermediaryClientId": null
+                },
+                {
+                    "id": "Client_Maple",
+                    "name": "Maple Health Group",
+                    "alias": "Maple",
+                    "intermediaryClientId": null
+                },
+                {
+                    "id": "Client_ES",
+                    "name": "Exact Sciences",
+                    "alias": "ES",
+                    "intermediaryClientId": "Client_Maple"
+                },
+                {
+                    "id": "Client_Ethaos",
+                    "name": "Ethaos",
+                    "alias": null,
+                    "intermediaryClientId": null
+                },
+                {
+                    "id": "Client_PostXL",
+                    "name": "PostXL",
+                    "alias": "PXL",
+                    "intermediaryClientId": null
+                },
+                {
+                    "id": "Client_USP",
+                    "name": "USP",
+                    "alias": "US Pharmacopeia, United States Pharmacopeia",
+                    "intermediaryClientId": null
+                },
+                {
+                    "id": "Client_d2iDD",
+                    "name": "data2impact Dresden",
+                    "alias": "d2i DD",
+                    "intermediaryClientId": null
+                },
+                {
+                    "id": "Client_d2iDK",
+                    "name": "data2impact DK",
+                    "alias": "d2i DK",
+                    "intermediaryClientId": null
+                }
+            ]
+        },
+        {
+            "name": "ClientOffice",
+            "description": "",
+            "fields": [
+                {
+                    "name": "clientId",
+                    "type": "Client",
+                    "label": "ClientId"
+                },
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the office."
+                },
+                {
+                    "name": "address",
+                    "type": "String",
+                    "label": "Address",
+                    "description": "The address of the office."
+                },
+                {
+                    "name": "city",
+                    "type": "String",
+                    "label": "City",
+                    "description": "The city of the office."
+                },
+                {
+                    "name": "postalCode",
+                    "type": "String",
+                    "label": "PostalCode",
+                    "description": "The postal code of the office."
+                },
+                {
+                    "name": "countryId",
+                    "type": "Country",
+                    "label": "CountryId",
+                    "description": "The country of the office."
+                },
+                {
+                    "name": "vatId",
+                    "type": "String?",
+                    "label": "VatId",
+                    "description": "The VAT ID of the office."
+                }
+            ]
+        },
+        {
+            "name": "Country",
+            "description": "A lookup table, demonstrating the use of a @@IsDefault. See description of `isDefault` field for details.",
+            "fields": [
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the country."
+                },
+                {
+                    "name": "countryCode",
+                    "type": "String",
+                    "label": "CountryCode",
+                    "description": "The country's ISO 3166-1 alpha-2 code."
+                }
+            ],
+            "seed": [
+                {
+                    "id": "US",
+                    "name": "US",
+                    "countryCode": "US"
+                },
+                {
+                    "id": "DE",
+                    "name": "Germany",
+                    "countryCode": "DE"
+                },
+                {
+                    "id": "DK",
+                    "name": "Denmark",
+                    "countryCode": "DK"
+                },
+                {
+                    "id": "GB",
+                    "name": "United Kingdom",
+                    "countryCode": "GB"
+                }
+            ]
+        },
+        {
+            "name": "Contact",
+            "description": "A contact of a (prospective) client.",
+            "fields": [
+                {
+                    "name": "name",
+                    "type": "String",
+                    "label": "Name",
+                    "description": "The name of the contact."
+                },
+                {
+                    "name": "clientId",
+                    "type": "Client?",
+                    "label": "ClientId",
+                    "description": "The client the contact is associated with."
+                },
+                {
+                    "name": "clientOfficeId",
+                    "type": "ClientOffice?",
+                    "label": "ClientOfficeId",
+                    "description": "The office the contact is associated with."
+                },
+                {
+                    "name": "role",
+                    "type": "String",
+                    "label": "Role"
+                },
+                {
+                    "name": "email",
+                    "type": "String",
+                    "label": "Email",
+                    "description": "The email of the contact."
+                },
+                {
+                    "name": "phone",
+                    "type": "String",
+                    "label": "Phone",
+                    "description": "The phone number of the contact."
+                },
+                {
+                    "name": "personalAddress",
+                    "type": "String?",
+                    "label": "PersonalAddress",
+                    "description": "The personal address of the contact."
+                },
+                {
+                    "name": "linkedInProfile",
+                    "type": "String?",
+                    "label": "LinkedInProfile",
+                    "description": "The LinkedIn profile of the contact."
+                },
+                {
+                    "name": "mainTeamContactId",
+                    "type": "TeamMember",
+                    "label": "Main Team contact",
+                    "description": "Who is the main 'owner' of the contact."
+                },
+                {
+                    "name": "remarks",
+                    "type": "String?",
+                    "label": "Remarks",
+                    "description": "Any remarks about the contact."
+                }
+            ]
+        },
+        {
+            "name": "TeamMember",
+            "description": "A team member.",
+            "standardFields": ["id", "createdAt", "updatedAt"],
+            "fields": [
+                {
+                    "name": "firstName",
+                    "type": "String",
+                    "label": "FirstName"
+                },
+                {
+                    "name": "lastName",
+                    "type": "String",
+                    "label": "LastName"
+                },
+                {
+                    "name": "email",
+                    "type": "String",
+                    "label": "Email"
+                },
+                {
+                    "name": "phone",
+                    "type": "String?",
+                    "label": "Phone"
+                },
+                {
+                    "name": "role",
+                    "type": "String",
+                    "label": "Role"
+                },
+                {
+                    "name": "isActive",
+                    "type": "Boolean",
+                    "label": "IsActive"
+                }
+            ],
+            "seed": [
+                {
+                    "id": "peter",
+                    "firstName": "Peter",
+                    "lastName": "Albert",
+                    "email": "peter.albert@postxl.com",
+                    "phone": "",
+                    "role": "CEO",
+                    "isActive": true
+                },
+                {
+                    "id": "johan",
+                    "firstName": "Johan",
+                    "lastName": "Kjeldgaard-Pedersen",
+                    "email": "johan.kjeldgaard-pedersen@postxl.com",
+                    "phone": "",
+                    "role": "CMO",
+                    "isActive": true
+                },
+                {
+                    "id": "chris",
+                    "firstName": "Chris",
+                    "lastName": "Herbst",
+                    "email": "chris.herbst@postxl.com",
+                    "phone": "",
+                    "role": "Senior Software Engineer",
+                    "isActive": true
+                }
+            ]
+        }
+    ],
+    "enums": [
+        {
+            "name": "DemoProjectStatus",
+            "description": "Status a DemoProject can have.",
+            "members": [
+                { "value": "Idea", "description": "Idea exists but is not implemented yet" },
+                { "value": "WorkInProgress", "description": "The demo project is currently being worked on" },
+                { "value": "Completed", "description": "The demo project is completed and can be used for presentations" },
+                { "value": "Cancelled", "description": "The demo project was cancelled" }
+            ]
+        },
+        {
+            "name": "ProjectPhaseStatus",
+            "description": "Status a ProjectPhase can have.",
+            "members": [
+                { "value": "TBD", "description": "The status of the project phase is to be determined" },
+                { "value": "InNegotiation", "description": "The project phase is in negotiation" },
+                { "value": "WorkInProgress", "description": "The project phase is currently being worked on" },
+                { "value": "Agreed", "description": "The project phase is agreed" },
+                { "value": "OngoingMaintenance", "description": "The project phase is in ongoing maintenance" },
+                { "value": "Invoiced", "description": "The project phase is invoiced" },
+                { "value": "ToBeInvoicedLater", "description": "The project phase is to be invoiced later" },
+                { "value": "Paid", "description": "The project phase is paid" }
+            ]
+        }
+    ]
+}