@planning-inspectorate/data-model 1.19.0 → 1.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/README.md +20 -0
- package/docs/nsip-project-defs-invoice.md +267 -0
- package/docs/nsip-project-defs-meeting.md +122 -0
- package/docs/nsip-project-defs.md +3 -0
- package/docs/nsip-project.md +1889 -7
- package/package.json +2 -2
- package/pins_data_model/models/model_appeal_document.py +1 -1
- package/pins_data_model/models/model_appeal_event.py +1 -1
- package/pins_data_model/models/model_appeal_event_estimate.py +1 -1
- package/pins_data_model/models/model_appeal_has.py +1 -1
- package/pins_data_model/models/model_appeal_representation.py +1 -1
- package/pins_data_model/models/model_appeal_s78.py +1 -1
- package/pins_data_model/models/model_dart_response.py +1 -1
- package/pins_data_model/models/model_entraid.py +1 -1
- package/pins_data_model/models/model_folder.py +1 -1
- package/pins_data_model/models/model_gettimesheets_response.py +1 -1
- package/pins_data_model/models/model_listed_building.py +1 -1
- package/pins_data_model/models/model_listed_buildings.py +1 -1
- package/pins_data_model/models/model_nsip_document.py +1 -1
- package/pins_data_model/models/model_nsip_exam_timetable.py +1 -1
- package/pins_data_model/models/model_nsip_project.py +535 -3
- package/pins_data_model/models/model_nsip_project_update.py +1 -1
- package/pins_data_model/models/model_nsip_representation.py +1 -1
- package/pins_data_model/models/model_nsip_subscription.py +1 -1
- package/pins_data_model/models/model_pins_inspector.py +1 -1
- package/pins_data_model/models/model_pins_lpa.py +1 -1
- package/pins_data_model/models/model_s51_advice.py +1 -1
- package/pins_data_model/models/model_service_user.py +1 -1
- package/schemas/nsip-project.schema.json +420 -2
- package/src/enums.cjs +678 -581
- package/src/enums.d.ts +668 -583
- package/src/enums.js +668 -583
- package/src/index.cjs +678 -581
- package/src/lib/gen-enums.js +1 -1
- package/src/schemas.d.ts +290 -3
package/src/lib/gen-enums.js
CHANGED
|
@@ -11,7 +11,7 @@ export const constPath = path.join(__dirname, '..', 'enums.js');
|
|
|
11
11
|
export const constTsPath = path.join(__dirname, '..', 'enums.d.ts');
|
|
12
12
|
|
|
13
13
|
const SPACING = ' ';
|
|
14
|
-
const NEW_LINE = '\
|
|
14
|
+
const NEW_LINE = '\n';
|
|
15
15
|
|
|
16
16
|
/**
|
|
17
17
|
* Load all schemas and generate JS constant definitions
|
package/src/schemas.d.ts
CHANGED
|
@@ -2090,9 +2090,18 @@ export interface NSIPProject {
|
|
|
2090
2090
|
projectDescription: string | null;
|
|
2091
2091
|
projectDescriptionWelsh?: string | null;
|
|
2092
2092
|
/**
|
|
2093
|
-
* Decision: approved/refused/split-decision
|
|
2094
|
-
*/
|
|
2095
|
-
decision:
|
|
2093
|
+
* Decision outcome: approved/refused/split-decision/granted/partially_consented/quashed/redetermination/withdrawn
|
|
2094
|
+
*/
|
|
2095
|
+
decision:
|
|
2096
|
+
| 'approved'
|
|
2097
|
+
| 'refused'
|
|
2098
|
+
| 'split-decision'
|
|
2099
|
+
| 'granted'
|
|
2100
|
+
| 'partially_consented'
|
|
2101
|
+
| 'quashed'
|
|
2102
|
+
| 'redetermination'
|
|
2103
|
+
| 'withdrawn'
|
|
2104
|
+
| null;
|
|
2096
2105
|
publishStatus: 'published' | 'unpublished' | null;
|
|
2097
2106
|
/**
|
|
2098
2107
|
* {Sector Abbreviation} - {Sector Display Name}
|
|
@@ -2382,6 +2391,284 @@ export interface NSIPProject {
|
|
|
2382
2391
|
* Is this an application for a material change?
|
|
2383
2392
|
*/
|
|
2384
2393
|
isMaterialChange?: boolean | null;
|
|
2394
|
+
/**
|
|
2395
|
+
* Date of court decision
|
|
2396
|
+
*/
|
|
2397
|
+
courtDecisionDate?: string | null;
|
|
2398
|
+
/**
|
|
2399
|
+
* Court decision outcome text; values include 'upheld','partially_upheld','quashed','other:<Text>'
|
|
2400
|
+
*/
|
|
2401
|
+
courtDecisionOutcomeText?: string | null;
|
|
2402
|
+
/**
|
|
2403
|
+
* Date of decision challenge submission
|
|
2404
|
+
*/
|
|
2405
|
+
decisionChallengeSubmissionDate?: string | null;
|
|
2406
|
+
/**
|
|
2407
|
+
* Recommendation
|
|
2408
|
+
*/
|
|
2409
|
+
recommendation?: 'recommend_consent' | 'recommend_partial_consent' | 'recommend_refusal' | null;
|
|
2410
|
+
/**
|
|
2411
|
+
* Date of inception meeting
|
|
2412
|
+
*/
|
|
2413
|
+
inceptionMeetingDate?: string | null;
|
|
2414
|
+
/**
|
|
2415
|
+
* Date for submission of draft documents
|
|
2416
|
+
*/
|
|
2417
|
+
draftDocumentSubmissionDate?: string | null;
|
|
2418
|
+
/**
|
|
2419
|
+
* Programme document submission date
|
|
2420
|
+
*/
|
|
2421
|
+
programmeDocumentSubmissionDate?: string | null;
|
|
2422
|
+
/**
|
|
2423
|
+
* Tier
|
|
2424
|
+
*/
|
|
2425
|
+
tier?: 'basic' | 'standard' | 'enhanced' | null;
|
|
2426
|
+
/**
|
|
2427
|
+
* Link to s61 summary
|
|
2428
|
+
*/
|
|
2429
|
+
s61SummaryURI?: string | null;
|
|
2430
|
+
/**
|
|
2431
|
+
* Estimated scoping submission date
|
|
2432
|
+
*/
|
|
2433
|
+
estimatedScopingSubmissionDate?: string | null;
|
|
2434
|
+
/**
|
|
2435
|
+
* Adequacy of Consultation Milestone
|
|
2436
|
+
*/
|
|
2437
|
+
consultationMilestoneAdequacyDate?: string | null;
|
|
2438
|
+
/**
|
|
2439
|
+
* Evidence plan process
|
|
2440
|
+
*/
|
|
2441
|
+
planProcessEvidence?: boolean | null;
|
|
2442
|
+
/**
|
|
2443
|
+
* Issues tracker
|
|
2444
|
+
*/
|
|
2445
|
+
issuesTracker?: string | null;
|
|
2446
|
+
/**
|
|
2447
|
+
* Essential fast track components
|
|
2448
|
+
*/
|
|
2449
|
+
essentialFastTrackComponents?: boolean | null;
|
|
2450
|
+
/**
|
|
2451
|
+
* Principal area disagreement summary statement (PADSS)
|
|
2452
|
+
*/
|
|
2453
|
+
principalAreaDisagreementSummaryStmt?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
|
|
2454
|
+
/**
|
|
2455
|
+
* Principal area disagreement summary statement (PADSS) Submitted date
|
|
2456
|
+
*/
|
|
2457
|
+
principalAreaDisagreementSummaryStmtSubmittedDate?: string | null;
|
|
2458
|
+
/**
|
|
2459
|
+
* Policy compliance document (PCD)
|
|
2460
|
+
*/
|
|
2461
|
+
policyComplianceDocument?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
|
|
2462
|
+
/**
|
|
2463
|
+
* Policy compliance document (PCD) Submitted Date
|
|
2464
|
+
*/
|
|
2465
|
+
policyComplianceDocumentSubmittedDate?: string | null;
|
|
2466
|
+
/**
|
|
2467
|
+
* Design approach document (DAD)
|
|
2468
|
+
*/
|
|
2469
|
+
designApproachDocument?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
|
|
2470
|
+
/**
|
|
2471
|
+
* Design approach document (DAD) Submitted Date
|
|
2472
|
+
*/
|
|
2473
|
+
designApproachDocumentSubmittedDate?: string | null;
|
|
2474
|
+
/**
|
|
2475
|
+
* Mature outline control documents
|
|
2476
|
+
*/
|
|
2477
|
+
matureOutlineControlDocument?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
|
|
2478
|
+
/**
|
|
2479
|
+
* Mature outline control documents Submitted Date
|
|
2480
|
+
*/
|
|
2481
|
+
matureOutlineControlDocumentSubmittedDate?: string | null;
|
|
2482
|
+
/**
|
|
2483
|
+
* CA and TP evidence
|
|
2484
|
+
*/
|
|
2485
|
+
caAndTpEvidence?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
|
|
2486
|
+
/**
|
|
2487
|
+
* CA and TP evidence Submitted Date
|
|
2488
|
+
*/
|
|
2489
|
+
caAndTpEvidenceSubmittedDate?: string | null;
|
|
2490
|
+
/**
|
|
2491
|
+
* Public sector equality duty (PSED)
|
|
2492
|
+
*/
|
|
2493
|
+
publicSectorEqualityDuty?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
|
|
2494
|
+
/**
|
|
2495
|
+
* Public sector equality duty (PSED) Submitted Date
|
|
2496
|
+
*/
|
|
2497
|
+
publicSectorEqualityDutySubmittedDate?: string | null;
|
|
2498
|
+
/**
|
|
2499
|
+
* Fast track admission document
|
|
2500
|
+
*/
|
|
2501
|
+
fastTrackAdmissionDocument?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
|
|
2502
|
+
/**
|
|
2503
|
+
* Fast track admission document Submitted Date
|
|
2504
|
+
*/
|
|
2505
|
+
fastTrackAdmissionDocumentSubmittedDate?: string | null;
|
|
2506
|
+
/**
|
|
2507
|
+
* Multiparty application readiness gate-check (trial)
|
|
2508
|
+
*/
|
|
2509
|
+
multipartyApplicationCheckDocument?: 'submitted_by_applicant' | 'awaiting_submission' | 'not_applicable' | null;
|
|
2510
|
+
/**
|
|
2511
|
+
* Multiparty application readiness gate-check Submitted Date (trial)
|
|
2512
|
+
*/
|
|
2513
|
+
multipartyApplicationCheckDocumentSubmittedDate?: string | null;
|
|
2514
|
+
/**
|
|
2515
|
+
* Link to programme document
|
|
2516
|
+
*/
|
|
2517
|
+
programmeDocumentURI?: string | null;
|
|
2518
|
+
/**
|
|
2519
|
+
* Date updated programme document is received
|
|
2520
|
+
*/
|
|
2521
|
+
updatedProgrammeDocumentReceivedDate?: string | null;
|
|
2522
|
+
/**
|
|
2523
|
+
* Date programme document reviewed by EST
|
|
2524
|
+
*/
|
|
2525
|
+
programmeDocumentReviewedByEstDate?: string | null;
|
|
2526
|
+
/**
|
|
2527
|
+
* Date case team issued comments on programme document
|
|
2528
|
+
*/
|
|
2529
|
+
caseTeamIssuedCommentsDate?: string | null;
|
|
2530
|
+
/**
|
|
2531
|
+
* Project type
|
|
2532
|
+
*/
|
|
2533
|
+
subProjectType?:
|
|
2534
|
+
| 'energy_from_waste'
|
|
2535
|
+
| 'gas_power_station'
|
|
2536
|
+
| 'hydrogen_power_station'
|
|
2537
|
+
| 'nuclear'
|
|
2538
|
+
| 'offshore_wind'
|
|
2539
|
+
| 'onshore_wind'
|
|
2540
|
+
| 'solar'
|
|
2541
|
+
| null;
|
|
2542
|
+
/**
|
|
2543
|
+
* New maturity
|
|
2544
|
+
*/
|
|
2545
|
+
newMaturity?: 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | null;
|
|
2546
|
+
/**
|
|
2547
|
+
* Statutory consultation period end date
|
|
2548
|
+
*/
|
|
2549
|
+
statutoryConsultationPeriodEndDate?: string | null;
|
|
2550
|
+
/**
|
|
2551
|
+
* Date for submission of draft documents
|
|
2552
|
+
*/
|
|
2553
|
+
submissionOfDraftDocumentsDate?: string | null;
|
|
2554
|
+
/**
|
|
2555
|
+
* Number of band 2 inspectors
|
|
2556
|
+
*/
|
|
2557
|
+
numberBand2Inspectors?: number | null;
|
|
2558
|
+
/**
|
|
2559
|
+
* Number of band 3 inspectors
|
|
2560
|
+
*/
|
|
2561
|
+
numberBand3Inspectors?: number | null;
|
|
2562
|
+
/**
|
|
2563
|
+
* MEM (last updated)
|
|
2564
|
+
*/
|
|
2565
|
+
memLastUpdated?: string | null;
|
|
2566
|
+
/**
|
|
2567
|
+
* Additional comments
|
|
2568
|
+
*/
|
|
2569
|
+
additionalComments?: string | null;
|
|
2570
|
+
/**
|
|
2571
|
+
* Maps to [Employee].[EmployeeID].
|
|
2572
|
+
*/
|
|
2573
|
+
operationsLeadIds?: string[];
|
|
2574
|
+
/**
|
|
2575
|
+
* New NSIP role, Maps to [Employee].[EmployeeID]
|
|
2576
|
+
*/
|
|
2577
|
+
operationsManagerIds?: string[];
|
|
2578
|
+
/**
|
|
2579
|
+
* Maps to [Employee].[EmployeeID].
|
|
2580
|
+
*/
|
|
2581
|
+
caseManagerIds?: string[];
|
|
2582
|
+
/**
|
|
2583
|
+
* Maps to [Employee].[EmployeeID].
|
|
2584
|
+
*/
|
|
2585
|
+
leadInspectorIds?: string[];
|
|
2586
|
+
/**
|
|
2587
|
+
* Maps to [Employee].[EmployeeID].
|
|
2588
|
+
*/
|
|
2589
|
+
environmentalServicesOfficerIds?: string[];
|
|
2590
|
+
/**
|
|
2591
|
+
* Maps to [Employee].[EmployeeID].
|
|
2592
|
+
*/
|
|
2593
|
+
legalOfficerIds?: string[];
|
|
2594
|
+
/**
|
|
2595
|
+
* Collection of meetings associated with this project
|
|
2596
|
+
*/
|
|
2597
|
+
meetings?: Meeting[];
|
|
2598
|
+
/**
|
|
2599
|
+
* Collection of invoices associated with this project
|
|
2600
|
+
*/
|
|
2601
|
+
invoices?: Invoice[];
|
|
2602
|
+
[k: string]: unknown;
|
|
2603
|
+
}
|
|
2604
|
+
/**
|
|
2605
|
+
* A meeting related to the project
|
|
2606
|
+
*/
|
|
2607
|
+
export interface Meeting {
|
|
2608
|
+
/**
|
|
2609
|
+
* Meeting agenda
|
|
2610
|
+
*/
|
|
2611
|
+
meetingAgenda?: string | null;
|
|
2612
|
+
/**
|
|
2613
|
+
* Planning Inspectorate role
|
|
2614
|
+
*/
|
|
2615
|
+
planningInspectorateRole?: 'facilitator' | 'advisor' | 'observer' | null;
|
|
2616
|
+
/**
|
|
2617
|
+
* Meeting date
|
|
2618
|
+
*/
|
|
2619
|
+
meetingDate?: string | null;
|
|
2620
|
+
/**
|
|
2621
|
+
* Type of Meeting
|
|
2622
|
+
*/
|
|
2623
|
+
meetingType?: string | null;
|
|
2624
|
+
[k: string]: unknown;
|
|
2625
|
+
}
|
|
2626
|
+
/**
|
|
2627
|
+
* An invoice related to the project
|
|
2628
|
+
*/
|
|
2629
|
+
export interface Invoice {
|
|
2630
|
+
/**
|
|
2631
|
+
* Invoice stage
|
|
2632
|
+
*/
|
|
2633
|
+
invoiceStage?:
|
|
2634
|
+
| 'pre_acceptance'
|
|
2635
|
+
| 'acceptance'
|
|
2636
|
+
| 'pre_examination'
|
|
2637
|
+
| 'initial_examination'
|
|
2638
|
+
| 'final_examination'
|
|
2639
|
+
| null;
|
|
2640
|
+
/**
|
|
2641
|
+
* Invoice number
|
|
2642
|
+
*/
|
|
2643
|
+
invoiceNumber: string;
|
|
2644
|
+
/**
|
|
2645
|
+
* Amount due
|
|
2646
|
+
*/
|
|
2647
|
+
amountDue: number;
|
|
2648
|
+
/**
|
|
2649
|
+
* Payment due date
|
|
2650
|
+
*/
|
|
2651
|
+
paymentDueDate?: string | null;
|
|
2652
|
+
/**
|
|
2653
|
+
* Invoiced date
|
|
2654
|
+
*/
|
|
2655
|
+
invoicedDate?: string | null;
|
|
2656
|
+
/**
|
|
2657
|
+
* Date of payment
|
|
2658
|
+
*/
|
|
2659
|
+
paymentDate?: string | null;
|
|
2660
|
+
/**
|
|
2661
|
+
* Refund credit note number
|
|
2662
|
+
*/
|
|
2663
|
+
refundCreditNoteNumber?: string | null;
|
|
2664
|
+
/**
|
|
2665
|
+
* Amount refunded
|
|
2666
|
+
*/
|
|
2667
|
+
refundAmount?: number | null;
|
|
2668
|
+
/**
|
|
2669
|
+
* Refund issue date
|
|
2670
|
+
*/
|
|
2671
|
+
refundIssueDate?: string | null;
|
|
2385
2672
|
[k: string]: unknown;
|
|
2386
2673
|
}
|
|
2387
2674
|
|