@oimlsmart/primmel-packages 0.1.0

package/oiml-smart-core/entities/module-b.prl

@@ -0,0 +1,214 @@
+class Marking#data {
+  store { markings }
+  description { "One marking applied to the instrument under evaluation (TODO.roadmap/55 — BUG.R60-SSOT gap 5: the Module-B documentary objects get a typed entity home in Core; R 60-1:2021, 6.2 'Inscriptions and presentation of load cell information'). The instance carries its declared entries (the 6.2.1 mandatory set: manufacturer's name or trade mark, type designation or load cell model, serial number, maximum capacity E_max, year of production, type approval mark where applicable; the 6.2.4 specific markings: accuracy class designation, load-type designation), where it sits on the instrument, and its lifecycle state (the Marking state machine, evaluation/state-machines.yaml: DRAFT → AFFIXED → INSPECTED → SUPERSEDED — a new data plate supersedes the affixed one, never edits it: 6.2.1 requires markings indelible and, as sticker/data plate, impossible to remove without damaging)." }
+  indexes { sample_id model_id standard_id status }
+  id: string {
+    modality SHALL
+  }
+  standard_id: string {
+    modality SHALL
+  }
+  sample_id: reference(MeasuringInstrumentSample) [0..1] {
+    modality MAY
+    definition "The sample carrying this marking; absent on a type-level (model) marking"
+    on_delete restrict
+    required false
+  }
+  model_id: reference(MeasuringInstrumentModel) [0..1] {
+    modality MAY
+    definition "The model the marking belongs to (denormalized from sample_id.model_id when the sample is set)"
+    on_delete restrict
+    required false
+  }
+  kind: enum {
+    modality SHALL
+    definition "mandatory = the R 60-1, 6.2.1 set; specific = the 6.2.4 designations (accuracy class, type of load applied)"
+    enum_values { mandatory specific }
+  }
+  items: string[] [0..*] {
+    modality SHALL
+    definition "The marking entries as text (e.g. 'E_max = 500 kg') — the record carries the strings, never a shape registry"
+  }
+  location: string [0..1] {
+    modality MAY
+    definition "Where on the instrument the marking sits (data plate, sticker — R 60-1, 6.2.1: impossible to remove without damaging)"
+  }
+  status: enum {
+    modality SHALL
+    definition "Lifecycle per evaluation/state-machines.yaml Marking machine (DRAFT → AFFIXED → INSPECTED → SUPERSEDED)"
+    enum_values { DRAFT AFFIXED INSPECTED SUPERSEDED }
+  }
+  affixed_by: string [0..1] {
+    modality MAY
+    definition "Who affixed the marking (manufacturer or, on re-plating, the authorized service)"
+  }
+  affixed_at: datetime [0..1] {
+    modality MAY
+  }
+  inspected_by: string [0..1] {
+    modality MAY
+    definition "The examiner who inspected the affixed marking (the marking examination of the type evaluation programme)"
+  }
+  inspected_at: datetime [0..1] {
+    modality MAY
+  }
+  superseded_by: reference(Marking) [0..1] {
+    modality MAY
+    definition "The marking that replaces this one — the chain (same discipline as VerificationRecord.previous_verification_id)"
+    on_delete nullify
+    required false
+  }
+  clause: string [0..1] {
+    modality MAY
+    definition "Clause the marking discharges (e.g. R 60-1, 6.2.2)"
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class Sealing#data {
+  store { sealings }
+  description { "One sealing record on the instrument (TODO.roadmap/55 — BUG.R60-SSOT gap 5; R 60-1:2021, 6.1: 'Provision shall be made for appropriate sealing by mechanical, electronic and/or cryptographic means, making any change that affects the metrological integrity of the device impossible or evident'). Sealing existed as TERMINOLOGY only (verification.prl SealStatus.means — 'Sealing means…') — this is the typed documentary object: what the seal protects, the sealing means, where it sits, and its lifecycle state (the Sealing state machine: DRAFT → AFFIXED → INSPECTED → SUPERSEDED — a re-seal after authorized intervention supersedes the prior seal record)." }
+  indexes { sample_id model_id standard_id status }
+  id: string {
+    modality SHALL
+  }
+  standard_id: string {
+    modality SHALL
+  }
+  sample_id: reference(MeasuringInstrumentSample) [0..1] {
+    modality MAY
+    definition "The sample carrying this seal; absent on a type-level sealing declaration"
+    on_delete restrict
+    required false
+  }
+  model_id: reference(MeasuringInstrumentModel) [0..1] {
+    modality MAY
+    definition "The model the sealing belongs to (denormalized from sample_id.model_id when the sample is set)"
+    on_delete restrict
+    required false
+  }
+  protects: string {
+    modality SHALL
+    definition "What the seal protects — the metrological integrity of the device (software/firmware per R 60-1, 6.1; adjustment means; metrology-relevant parts)"
+  }
+  means: string [0..1] {
+    modality MAY
+    definition "Sealing means — mechanical, electronic and/or cryptographic (R 60-1, 6.1), giving clear evidence of tampering"
+  }
+  location: string [0..1] {
+    modality MAY
+    definition "Where on the instrument the seal sits"
+  }
+  status: enum {
+    modality SHALL
+    definition "Lifecycle per evaluation/state-machines.yaml Sealing machine (DRAFT → AFFIXED → INSPECTED → SUPERSEDED)"
+    enum_values { DRAFT AFFIXED INSPECTED SUPERSEDED }
+  }
+  affixed_by: string [0..1] {
+    modality MAY
+  }
+  affixed_at: datetime [0..1] {
+    modality MAY
+  }
+  inspected_by: string [0..1] {
+    modality MAY
+    definition "The examiner who inspected the seal's integrity"
+  }
+  inspected_at: datetime [0..1] {
+    modality MAY
+  }
+  superseded_by: reference(Sealing) [0..1] {
+    modality MAY
+    definition "The sealing record that replaces this one after a (re-)seal — the chain"
+    on_delete nullify
+    required false
+  }
+  clause: string [0..1] {
+    modality MAY
+    definition "Clause the seal discharges (e.g. R 60-1, 6.1)"
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class CalibrationRecord#data {
+  store { calibrationRecords }
+  description { "One calibration record for a piece of test equipment used in the type evaluation (TODO.roadmap/55 — BUG.R60-SSOT gap 5; ISO/IEC 17025:2017, 6.4.6/6.5 — equipment is calibrated where the accuracy affects the validity of the reported results, establishing their metrological traceability; the R 60-2 test equipment, e.g. the force machine and the R 60-3, 4.10.3 temperature chamber). The record links the equipment to its calibration certificate, the calibrating body, and the validity window; the lifecycle (the CalibrationRecord state machine: DRAFT → AFFIXED → INSPECTED → SUPERSEDED) chains re-calibrations — the current record supersedes the expired one, never edits it." }
+  indexes { equipment_id laboratory_id status }
+  id: string {
+    modality SHALL
+  }
+  standard_id: string {
+    modality SHALL
+  }
+  equipment_id: string {
+    modality SHALL
+    definition "Lab-local equipment identifier this record calibrates (the VerificationEquipment/TestEquipment id — traceability)"
+  }
+  laboratory_id: reference(TestLaboratory) [0..1] {
+    modality MAY
+    definition "The body that performed the calibration"
+    on_delete restrict
+    required false
+  }
+  certificate: string {
+    modality SHALL
+    definition "Calibration certificate reference (ISO/IEC 17025, 6.4.6)"
+  }
+  calibrated_at: date {
+    modality SHALL
+  }
+  valid_until: date [0..1] {
+    modality MAY
+    definition "End of the calibration validity window — re-calibration due (supersession trigger)"
+  }
+  uncertainty: string [0..1] {
+    modality MAY
+    definition "The calibration's declared measurement uncertainty (traceability statement, ISO/IEC 17025, 6.5)"
+  }
+  status: enum {
+    modality SHALL
+    definition "Lifecycle per evaluation/state-machines.yaml CalibrationRecord machine (DRAFT → AFFIXED → INSPECTED → SUPERSEDED)"
+    enum_values { DRAFT AFFIXED INSPECTED SUPERSEDED }
+  }
+  affixed_by: string [0..1] {
+    modality MAY
+    definition "Who attached the record to the equipment file"
+  }
+  affixed_at: datetime [0..1] {
+    modality MAY
+  }
+  inspected_by: string [0..1] {
+    modality MAY
+    definition "The assessor who inspected the record (laboratory assessment / test-witnessing)"
+  }
+  inspected_at: datetime [0..1] {
+    modality MAY
+  }
+  superseded_by: reference(CalibrationRecord) [0..1] {
+    modality MAY
+    definition "The record that replaces this one on re-calibration — the chain"
+    on_delete nullify
+    required false
+  }
+  clause: string [0..1] {
+    modality MAY
+    definition "Clause the record discharges (e.g. ISO/IEC 17025:2017, 6.4.6)"
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+

package/oiml-smart-core/entities/operated-schemes.prl

@@ -0,0 +1,141 @@
+class OperatedScheme#data {
+  store { operatedSchemes }
+  description { "One certification scheme THIS instance operates (TODO.adoption/05, the multi-scheme reality: a national metrology institute is simultaneously an OIML-CS Issuing Authority and its national approval scheme's body; the established institute practice: one conformity-evaluation body running the OIML-CS, the national ordinances, the regional assessments and more, each with its own marking, certificate types and numbering formats). The record declares the scheme's identity (name, conformity marking, legal-basis citations), the certificate numbering format (a pattern template; the calculus in browser/src/data/operated-schemes.ts validates and renders it), the certificate types it issues, the register access tier (public / brief_public / authority_only, the publication practice of the body's own register), and the validity rule. The OIML-CS ships as the BUILT-IN record (built_in: true): it is declared by the calculus, never persisted in this store, and it is the only record whose numbering is the coded Annex B generator (certificate.service.ts) rather than a template. The honest boundary: a certificate issued under any other scheme is NOT an OIML-CS certificate (no Annex B number, no BIML registration, no OIML marking, no OIML-CS Declaration gate), and the OIML-CS scheme's own discipline is untouched by any record here." }
+  indexes { status }
+  id: string {
+    modality SHALL
+    definition "The scheme slug (lowercase-hyphenated, e.g. ex-nta). The built-in OIML-CS record's id is the fixed token oiml-cs; an instance record may never take it"
+  }
+  name: string {
+    modality SHALL
+    definition "The scheme's full name as the body styles it (e.g. the national type approval scheme's title)"
+  }
+  short_name: string [0..1] {
+    modality MAY
+    definition "The badge label on certificate rows and the register filter (defaults to the name)"
+  }
+  marking: string {
+    modality SHALL
+    definition "The conformity marking the scheme authorizes, as its short label: OIML, CE, CH, UKCA, a national mark, or 'none' when the scheme affixes no mark (the guide practice: each scheme has its own marking)"
+  }
+  legal_basis: string[] [0..*] {
+    modality MAY
+    definition "The legal-basis citations the scheme operates under (the ordinance/directive references, one per entry, e.g. the national measuring-instruments ordinance with its article); shown on the registry and the certificate surface as the scheme's provenance"
+  }
+  numbering_pattern: string {
+    modality SHALL
+    definition "The certificate numbering template the scheme mints with. Tokens: {CAT} the instrument-category code (resolved through category_codes, else the category id), {YYYY} / {YY} the issue year, {SEQ:n} the per-scheme sequence zero-padded to n (counted per year, and per category when the pattern carries {CAT}, the reference-within-category practice), {REV} / {REV:n} the revision (rendered from the first revision on; an initial issue renders REV as its zero value). The built-in oiml-cs record carries the Annex B shape informatively (R{REC}/{EDITION}-{A|B}-{IA}-{YY}.{NN}): its numbering is the coded generator, never this template"
+  }
+  category_codes: object [0..1] {
+    modality MAY
+    definition "The scheme's own category vocabulary for the {CAT} token: a map from the platform's instrument-category id (e.g. load-cells) to the scheme's code (e.g. its ordinance's instrument class). A category with no entry renders as the uppercased category id"
+  }
+  certificate_types: string[] [1..*] {
+    modality SHALL
+    definition "The certificate types the scheme issues, from the calculus vocabulary (CERTIFICATE_TYPE_IDS: type_approval, type_evaluation, evaluation_unit, qms, product_verification, test_report, oiml_certificate, other). Declarative: the register and the registry page show them; the platform's workflow issues the type certificate"
+  }
+  access_tier: enum {
+    modality SHALL
+    definition "The body's register publication rule for this scheme's certificates (the guide's §4.2.2 practice): public lists with the full public view for everyone (the OIML-CS built-in's tier, B 18:2025 §15.8); brief_public shows the public a brief description while the full certificate view is reserved to registered market-surveillance authority accounts and the register's operators; authority_only is not listed publicly at all and is available to the authority accounts (the product-verification practice: on request by the authorities)"
+    enum_values { public brief_public authority_only }
+  }
+  validity_years: integer [0..1] {
+    modality MAY
+    definition "The type certificate's validity period in years when the scheme fixes one; absent means no fixed validity period (the OIML-CS practice: an OIML certificate does not have a period of validity). The issuance form prefills the expiry from it"
+  }
+  validity_note: string [0..1] {
+    modality MAY
+    definition "The validity rule as the scheme states it (e.g. per the ordinance), shown beside the years"
+  }
+  built_in: boolean {
+    modality SHALL
+    definition "True only on the platform-shipped OIML-CS record (declared by the calculus, never persisted). Instance records are always false: the built-in is immutable and undeletable, an instance record is managed by the instance's administrators and never deleted while certificates reference it (retire it instead)"
+  }
+  status: enum {
+    modality SHALL
+    definition "active: the scheme issues. retired: the scheme issues nothing new; its certificates stay on the register under their own numbering and tiers (a withdrawn national scheme's register entries remain the record)"
+    enum_values { active retired }
+  }
+  description: text [0..1] {
+    modality MAY
+    definition "What the scheme is and who it serves, in the body's own words (the registry page's explanatory text)"
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+
+class SchemeNumbering#data {
+  helper { true }
+  sequence: integer {
+    modality SHALL
+    definition "The per-scheme sequence the number was minted with (counted per issue year, and per category when the scheme's pattern carries {CAT})"
+  }
+  issue_year: integer {
+    modality SHALL
+    definition "The year of initial certification the number carries; a revision keeps it (the number's year never moves)"
+  }
+  category_code: string [0..1] {
+    modality MAY
+    definition "The resolved {CAT} token value (the scheme's own category code) when the pattern carries the token"
+  }
+}
+
+class DocumentListEntry#data {
+  helper { true }
+  title: string {
+    modality SHALL
+    definition "The document's title as the list names it (the technical document, test report, or firmware version the certificate rests on)"
+  }
+  document: reference(DocumentRef) [0..1] {
+    modality MAY
+    definition "The stored document (TODO.adoption/03 blob slot); absent in the file-name-only posture, the entry then names the document without holding its bytes"
+    on_delete nullify
+  }
+  note: string [0..1] {
+    modality MAY
+    definition "The entry's annotation (a version, a page count, a supersession note)"
+  }
+}
+
+class CertificateDocumentList#data {
+  store { certificateDocumentLists }
+  description { "The certificate's companion document list (TODO.adoption/05, the Doc_List_TEC / LERD practice of the conformity body's guide §4.1.8): the list of the underlying test reports, technical documents and firmware versions the certificate rests on. A document list may be REVISED WITHOUT REVISING THE CERTIFICATE: a technical change that does not impact the certificate's content revises the list alone (its own revision counter), so the certificate's revision log and (for the OIML-CS) the registered copy's digest stay untouched. One list per certificate, revisioned in place: the record carries the current revision and its note; the revision history lives in the audit journal." }
+  indexes { certificate_id }
+  id: string {
+    modality SHALL
+  }
+  certificate_id: reference(Certificate) {
+    modality SHALL
+    definition "The certificate this list accompanies"
+    on_delete cascade
+  }
+  revision: integer {
+    modality SHALL
+    definition "The list's OWN revision counter (0 at creation), independent of the certificate's revisions: revising the list never revises the certificate"
+  }
+  entries: reference(DocumentListEntry) [0..*] {
+    modality MAY
+    definition "The listed documents"
+    on_delete nullify
+    required false
+  }
+  revision_note: string [0..1] {
+    modality MAY
+    definition "What changed in this revision of the list (the technical change that did not touch the certificate)"
+  }
+  revised_by: string [0..1] {
+    modality MAY
+    definition "The account name of who revised the list (provenance)"
+  }
+  created: datetime {
+    modality SHALL
+  }
+  modified: datetime {
+    modality SHALL
+  }
+}
+