@tiangong-lca/pcr 0.3.1 → 0.4.0

package/node_modules/zwitch/readme.md

@@ -0,0 +1,226 @@
+# zwitch
+
+[![Build][build-badge]][build]
+[![Coverage][coverage-badge]][coverage]
+[![Downloads][downloads-badge]][downloads]
+[![Size][size-badge]][size]
+
+Handle values based on a field.
+
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`zwitch(key[, options])`](#zwitchkey-options)
+    *   [`one(value[, rest…])`](#onevalue-rest)
+    *   [`function handler(value[, rest…])`](#function-handlervalue-rest)
+*   [Types](#types)
+*   [Compatibility](#compatibility)
+*   [Related](#related)
+*   [Contribute](#contribute)
+*   [Security](#security)
+*   [License](#license)
+
+## What is this?
+
+This is a tiny package that lets you `switch` between some field on objects.
+
+## When should I use this?
+
+This package is very useful when mapping one AST to another.
+It’s a lot like a `switch` statement on one field, but it’s extensible.
+
+## Install
+
+This package is [ESM only][esm].
+In Node.js (version 14.14+, 16.0+), install with [npm][]:
+
+```sh
+npm install zwitch
+```
+
+In Deno with [`esm.sh`][esmsh]:
+
+```js
+import {zwitch} from 'https://esm.sh/zwitch@2'
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+  import {zwitch} from 'https://esm.sh/zwitch@2?bundle'
+</script>
+```
+
+## Use
+
+```js
+import {zwitch} from 'zwitch'
+
+const handle = zwitch('type', {invalid, unknown, handlers: {alpha: handleAlpha}})
+
+handle({type: 'alpha'})
+
+function handleAlpha() { /* … */ }
+```
+
+Or, with a `switch` statement:
+
+```js
+const field = 'type'
+
+function handle(value) {
+  let fn = invalid
+
+  if (value && typeof value === 'object' && field in value) {
+    switch (value[field]) {
+      case 'alpha':
+        fn = handleAlpha
+        break
+      default:
+        fn = unknown
+        break
+    }
+  }
+
+  return fn.apply(this, arguments)
+}
+
+handle({type: 'alpha'})
+
+function handleAlpha() { /* … */ }
+function unknown() { /* … */ }
+function invalid() { /* … */ }
+```
+
+## API
+
+This package exports the identifier `zwitch`.
+There is no default export.
+
+### `zwitch(key[, options])`
+
+Create a switch, based on a `key` (`string`).
+
+##### `options`
+
+Options can be omitted and added later to `one`.
+
+###### `options.handlers`
+
+Handlers to use, stored on `one.handlers` (`Record<string, Function>`,
+optional).
+
+###### `options.unknown`
+
+Handler to use for unknown values, stored on `one.unknown` (`Function`,
+optional).
+
+###### `options.invalid`
+
+Handler to use for invalid values, stored on `one.invalid` (`Function`,
+optional).
+
+###### Returns
+
+See [`one`][one] (`Function`).
+
+### `one(value[, rest…])`
+
+Handle one value.
+Based on the bound `key`, a respective handler will be called.
+If `value` is not an object, or doesn’t have a `key` property, the special
+“invalid” handler will be called.
+If `value` has an unknown `key`, the special “unknown” handler will be called.
+
+All arguments, and the context object (`this`), are passed through to the
+[handler][], and it’s result is returned.
+
+###### `one.handlers`
+
+Map of [handler][]s (`Record<string, Function>`).
+
+###### `one.invalid`
+
+Special [`handler`][handler] called if a value doesn’t have a `key` property.
+If not set, `undefined` is returned for invalid values.
+
+###### `one.unknown`
+
+Special [`handler`][handler] called if a value does not have a matching
+handler.
+If not set, `undefined` is returned for unknown values.
+
+### `function handler(value[, rest…])`
+
+Handle one value.
+
+## Types
+
+This package is fully typed with [TypeScript][].
+It exports the types `Handler`, `UnknownHandler`, `InvalidHandler`, and
+`Options`.
+
+## Compatibility
+
+This package is at least compatible with all maintained versions of Node.js.
+As of now, that is Node.js 14.14+ and 16.0+.
+It also works in Deno and modern browsers.
+
+## Related
+
+*   [`mapz`](https://github.com/wooorm/mapz)
+    — functional map
+
+## Contribute
+
+Yes please!
+See [How to Contribute to Open Source][contribute].
+
+## Security
+
+This package is safe.
+
+## License
+
+[MIT][license] © [Titus Wormer][author]
+
+<!-- Definitions -->
+
+[build-badge]: https://github.com/wooorm/zwitch/workflows/main/badge.svg
+
+[build]: https://github.com/wooorm/zwitch/actions
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/zwitch.svg
+
+[coverage]: https://codecov.io/github/wooorm/zwitch
+
+[downloads-badge]: https://img.shields.io/npm/dm/zwitch.svg
+
+[downloads]: https://www.npmjs.com/package/zwitch
+
+[size-badge]: https://img.shields.io/bundlephobia/minzip/zwitch.svg
+
+[size]: https://bundlephobia.com/result?p=zwitch
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[esmsh]: https://esm.sh
+
+[typescript]: https://www.typescriptlang.org
+
+[contribute]: https://opensource.guide/how-to-contribute/
+
+[license]: license
+
+[author]: https://wooorm.com
+
+[one]: #onevalue-rest
+
+[handler]: #function-handlervalue-rest

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiangong-lca/pcr",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "type": "module",
   "description": "Offline PCR consumer CLI and agent Skill",
   "license": "MIT",
@@ -8,7 +8,7 @@
     "node": ">=24.19.0"
   },
   "bin": {
-    "tiangong-pcr": "packages/tiangong-pcr-cli/bin/tiangong-pcr.mjs"
+    "tiangong-pcr": "packages/tiangong-pcr-cli/bin/tiangong-pcr.js"
   },
   "files": [
     "packages",
@@ -19,16 +19,24 @@
     "product-release.json"
   ],
   "dependencies": {
-    "ajv": "8.20.0"
+    "ajv": "8.20.0",
+    "remark-gfm": "4.0.1",
+    "remark-parse": "11.0.0",
+    "unified": "11.0.5",
+    "yaml": "2.9.1"
   },
   "bundleDependencies": [
-    "ajv"
+    "ajv",
+    "remark-gfm",
+    "remark-parse",
+    "unified",
+    "yaml"
   ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/tiangong-lca/pcr.git"
   },
-  "gitHead": "4226d2ab97d53682c967dd29a2a04d97debfc15e",
+  "gitHead": "d0198577159e82bcc12df14bfe59f8ed060e089a",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"

package/packages/pcr-core/schemas/guidance-batch-request.schema.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://tiangong-lca.org/schemas/pcr/v1/guidance-batch-request.schema.json",
+  "title": "PCR guidance batch request",
+  "type": "object",
+  "required": ["schema_version", "pcr_ids"],
+  "properties": {
+    "schema_version": { "const": 1 },
+    "pcr_ids": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string", "minLength": 1, "pattern": "\\S" } }
+  },
+  "additionalProperties": false
+}

package/packages/pcr-core/schemas/guidance-output.schema.json

@@ -24,74 +24,282 @@
     "validation_notes"
   ],
   "properties": {
-    "schema_version": { "const": 1 },
-    "guidance_kind": { "const": "tiangong-pcr-agent-guidance" },
-    "pcr": { "type": "object" },
+    "schema_version": {
+      "enum": [
+        1,
+        2
+      ]
+    },
+    "guidance_kind": {
+      "const": "tiangong-pcr-agent-guidance"
+    },
+    "pcr": {
+      "type": "object"
+    },
     "readiness": {
       "$ref": "https://tiangong-lca.org/schemas/pcr/v1/readiness.schema.json"
     },
-    "source_structured": { "type": "string", "minLength": 1 },
+    "source_structured": {
+      "type": "string",
+      "minLength": 1
+    },
     "system_boundary": {
       "type": "object",
-      "required": ["rules"],
+      "required": [
+        "rules"
+      ],
       "properties": {
-        "rules": { "$ref": "#/$defs/normativeRules" }
+        "rules": {
+          "$ref": "#/$defs/normativeRules"
+        }
       },
       "additionalProperties": false
     },
-    "reference_flow": { "type": "object" },
-    "boundary_abstraction": { "type": "object" },
-    "measurement_rules": { "$ref": "#/$defs/objectArray" },
-    "process_map": { "$ref": "#/$defs/objectArray" },
-    "process_inventory": { "$ref": "#/$defs/objectArray" },
+    "reference_flow": {
+      "type": "object"
+    },
+    "boundary_abstraction": {
+      "type": "object"
+    },
+    "measurement_rules": {
+      "$ref": "#/$defs/objectArray"
+    },
+    "process_map": {
+      "$ref": "#/$defs/objectArray"
+    },
+    "process_inventory": {
+      "$ref": "#/$defs/objectArray"
+    },
     "production_guidance": {
       "type": "object",
-      "required": ["collection_protocols", "calculation_rules", "data_quality_requirements"],
+      "required": [
+        "collection_protocols",
+        "calculation_rules",
+        "data_quality_requirements"
+      ],
       "properties": {
-        "collection_protocols": { "$ref": "#/$defs/objectArray" },
-        "calculation_rules": { "$ref": "#/$defs/objectArray" },
-        "data_quality_requirements": { "$ref": "#/$defs/objectArray" }
+        "collection_protocols": {
+          "$ref": "#/$defs/objectArray"
+        },
+        "calculation_rules": {
+          "$ref": "#/$defs/objectArray"
+        },
+        "data_quality_requirements": {
+          "$ref": "#/$defs/objectArray"
+        }
       },
       "additionalProperties": false
     },
-    "published_dataset_profile": { "type": "object" },
-    "allocation_rules": { "$ref": "#/$defs/normativeRules" },
-    "data_quality_rules": { "$ref": "#/$defs/objectArray" },
-    "validation_rules": { "$ref": "#/$defs/normativeRules" },
-    "data_sources": { "$ref": "#/$defs/objectArray" },
+    "published_dataset_profile": {
+      "type": "object"
+    },
+    "allocation_rules": {
+      "$ref": "#/$defs/normativeRules"
+    },
+    "data_quality_rules": {
+      "$ref": "#/$defs/objectArray"
+    },
+    "validation_rules": {
+      "$ref": "#/$defs/normativeRules"
+    },
+    "data_sources": {
+      "$ref": "#/$defs/objectArray"
+    },
     "validation_notes": {
       "type": "array",
-      "items": { "type": "string", "minLength": 1 }
+      "items": {
+        "type": "string",
+        "minLength": 1
+      }
+    },
+    "normative_context": {
+      "$ref": "https://tiangong-lca.org/schemas/pcr/v1/structured-projection.schema.json#/$defs/normativeContext"
+    },
+    "normative_context_provenance": {
+      "type": "object",
+      "required": [
+        "kind",
+        "compiler_contract_version",
+        "stored_projection_schema_version",
+        "stored_projection_sha256",
+        "source_sha256",
+        "context_sha256"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "stored_projection",
+            "derived_legacy_source"
+          ]
+        },
+        "compiler_contract_version": {
+          "const": "2"
+        },
+        "stored_projection_schema_version": {
+          "enum": [
+            1,
+            2
+          ]
+        },
+        "stored_projection_sha256": {
+          "type": "string",
+          "pattern": "^sha256:[0-9a-f]{64}$"
+        },
+        "source_sha256": {
+          "type": "string",
+          "pattern": "^sha256:[0-9a-f]{64}$"
+        },
+        "context_sha256": {
+          "type": "string",
+          "pattern": "^sha256:[0-9a-f]{64}$"
+        }
+      },
+      "additionalProperties": false,
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "kind": {
+                "const": "stored_projection"
+              }
+            },
+            "required": [
+              "kind"
+            ]
+          },
+          "then": {
+            "properties": {
+              "stored_projection_schema_version": {
+                "const": 2
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "kind": {
+                "const": "derived_legacy_source"
+              }
+            },
+            "required": [
+              "kind"
+            ]
+          },
+          "then": {
+            "properties": {
+              "stored_projection_schema_version": {
+                "const": 1
+              }
+            }
+          }
+        }
+      ]
     }
   },
   "additionalProperties": false,
   "$defs": {
     "objectArray": {
       "type": "array",
-      "items": { "type": "object" }
+      "items": {
+        "type": "object"
+      }
     },
     "normativeRules": {
       "type": "array",
-      "items": { "$ref": "#/$defs/normativeRule" }
+      "items": {
+        "$ref": "#/$defs/normativeRule"
+      }
     },
     "normativeRule": {
       "type": "object",
-      "required": ["rule_id", "applies_to", "rule", "source_ids"],
+      "required": [
+        "rule_id",
+        "applies_to",
+        "rule",
+        "source_ids"
+      ],
       "properties": {
         "rule_id": {
           "type": "string",
           "minLength": 1,
           "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$"
         },
-        "applies_to": { "type": "string", "minLength": 1 },
-        "rule": { "type": "string", "minLength": 1 },
+        "applies_to": {
+          "type": "string",
+          "minLength": 1
+        },
+        "rule": {
+          "type": "string",
+          "minLength": 1
+        },
         "source_ids": {
           "type": "array",
-          "items": { "type": "string", "minLength": 1 },
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
           "uniqueItems": true
         }
       },
       "additionalProperties": false
     }
-  }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "schema_version": {
+            "const": 1
+          }
+        },
+        "required": [
+          "schema_version"
+        ]
+      },
+      "then": {
+        "properties": {
+          "normative_context": false
+        },
+        "not": {
+          "anyOf": [
+            {
+              "required": [
+                "normative_context"
+              ],
+              "properties": {
+                "normative_context": {}
+              }
+            },
+            {
+              "required": [
+                "normative_context_provenance"
+              ],
+              "properties": {
+                "normative_context_provenance": {}
+              }
+            }
+          ]
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "schema_version": {
+            "const": 2
+          }
+        },
+        "required": [
+          "schema_version"
+        ]
+      },
+      "then": {
+        "required": [
+          "normative_context",
+          "normative_context_provenance"
+        ]
+      }
+    }
+  ]
 }