npm - @x12i/made-easy - Versions diffs - 0.0.0-stage → 0.1.0 - Mend

@x12i/made-easy 0.0.0-stage → 0.1.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.

Files changed (169) hide show

package/LICENSE +21 -0
package/README.md +57 -2
package/dist/analysis.d.ts +19 -0
package/dist/analysis.d.ts.map +1 -0
package/dist/analysis.js +90 -0
package/dist/analysis.js.map +1 -0
package/dist/build.d.ts +36 -0
package/dist/build.d.ts.map +1 -0
package/dist/build.js +260 -0
package/dist/build.js.map +1 -0
package/dist/contracts/api.d.ts +447 -0
package/dist/contracts/api.d.ts.map +1 -0
package/dist/contracts/api.js +152 -0
package/dist/contracts/api.js.map +1 -0
package/dist/contracts/blocks.d.ts +221 -0
package/dist/contracts/blocks.d.ts.map +1 -0
package/dist/contracts/blocks.js +392 -0
package/dist/contracts/blocks.js.map +1 -0
package/dist/contracts/diagnostics.d.ts +111 -0
package/dist/contracts/diagnostics.d.ts.map +1 -0
package/dist/contracts/diagnostics.js +122 -0
package/dist/contracts/diagnostics.js.map +1 -0
package/dist/contracts/index.d.ts +11 -0
package/dist/contracts/index.d.ts.map +1 -0
package/dist/contracts/index.js +11 -0
package/dist/contracts/index.js.map +1 -0
package/dist/contracts/json-schema.d.ts +5 -0
package/dist/contracts/json-schema.d.ts.map +1 -0
package/dist/contracts/json-schema.js +41 -0
package/dist/contracts/json-schema.js.map +1 -0
package/dist/contracts/recipe.d.ts +535 -0
package/dist/contracts/recipe.d.ts.map +1 -0
package/dist/contracts/recipe.js +380 -0
package/dist/contracts/recipe.js.map +1 -0
package/dist/contracts/schemas.d.ts +413 -0
package/dist/contracts/schemas.d.ts.map +1 -0
package/dist/contracts/schemas.js +205 -0
package/dist/contracts/schemas.js.map +1 -0
package/dist/draft.d.ts +157 -0
package/dist/draft.d.ts.map +1 -0
package/dist/draft.js +254 -0
package/dist/draft.js.map +1 -0
package/dist/emit-assets.d.ts +2 -0
package/dist/emit-assets.d.ts.map +1 -0
package/dist/emit-assets.js +27 -0
package/dist/emit-assets.js.map +1 -0
package/dist/index.d.ts +25 -0
package/dist/index.d.ts.map +1 -0
package/dist/index.js +30 -0
package/dist/index.js.map +1 -0
package/dist/markdown-doc.d.ts +59 -0
package/dist/markdown-doc.d.ts.map +1 -0
package/dist/markdown-doc.js +187 -0
package/dist/markdown-doc.js.map +1 -0
package/dist/model.d.ts +54 -0
package/dist/model.d.ts.map +1 -0
package/dist/model.js +244 -0
package/dist/model.js.map +1 -0
package/dist/normalize.d.ts +63 -0
package/dist/normalize.d.ts.map +1 -0
package/dist/normalize.js +54 -0
package/dist/normalize.js.map +1 -0
package/dist/npm.d.ts +24 -0
package/dist/npm.d.ts.map +1 -0
package/dist/npm.js +51 -0
package/dist/npm.js.map +1 -0
package/dist/render/blocks.d.ts +17 -0
package/dist/render/blocks.d.ts.map +1 -0
package/dist/render/blocks.js +384 -0
package/dist/render/blocks.js.map +1 -0
package/dist/render/brief.d.ts +77 -0
package/dist/render/brief.d.ts.map +1 -0
package/dist/render/brief.js +62 -0
package/dist/render/brief.js.map +1 -0
package/dist/render/context.d.ts +43 -0
package/dist/render/context.d.ts.map +1 -0
package/dist/render/context.js +88 -0
package/dist/render/context.js.map +1 -0
package/dist/render/html.d.ts +19 -0
package/dist/render/html.d.ts.map +1 -0
package/dist/render/html.js +178 -0
package/dist/render/html.js.map +1 -0
package/dist/render/markdown-out.d.ts +11 -0
package/dist/render/markdown-out.d.ts.map +1 -0
package/dist/render/markdown-out.js +121 -0
package/dist/render/markdown-out.js.map +1 -0
package/dist/render/pdf.d.ts +23 -0
package/dist/render/pdf.d.ts.map +1 -0
package/dist/render/pdf.js +138 -0
package/dist/render/pdf.js.map +1 -0
package/dist/render/prose.d.ts +15 -0
package/dist/render/prose.d.ts.map +1 -0
package/dist/render/prose.js +110 -0
package/dist/render/prose.js.map +1 -0
package/dist/scaffold.d.ts +13 -0
package/dist/scaffold.d.ts.map +1 -0
package/dist/scaffold.js +393 -0
package/dist/scaffold.js.map +1 -0
package/dist/sdk.d.ts +56 -0
package/dist/sdk.d.ts.map +1 -0
package/dist/sdk.js +238 -0
package/dist/sdk.js.map +1 -0
package/dist/source.d.ts +57 -0
package/dist/source.d.ts.map +1 -0
package/dist/source.js +289 -0
package/dist/source.js.map +1 -0
package/dist/theme/book.d.ts +10 -0
package/dist/theme/book.d.ts.map +1 -0
package/dist/theme/book.js +198 -0
package/dist/theme/book.js.map +1 -0
package/dist/util.d.ts +14 -0
package/dist/util.d.ts.map +1 -0
package/dist/util.js +69 -0
package/dist/util.js.map +1 -0
package/dist/validate.d.ts +36 -0
package/dist/validate.d.ts.map +1 -0
package/dist/validate.js +986 -0
package/dist/validate.js.map +1 -0
package/dist/verify.d.ts +35 -0
package/dist/verify.d.ts.map +1 -0
package/dist/verify.js +112 -0
package/dist/verify.js.map +1 -0
package/dist/version.d.ts +3 -0
package/dist/version.d.ts.map +1 -0
package/dist/version.js +4 -0
package/dist/version.js.map +1 -0
package/dist/yamlfile.d.ts +22 -0
package/dist/yamlfile.d.ts.map +1 -0
package/dist/yamlfile.js +129 -0
package/dist/yamlfile.js.map +1 -0
package/package.json +64 -4
package/recipes/index.json +282 -0
package/recipes/shared-1.0.0.json +456 -0
package/schemas/artifact.v1.json +36 -0
package/schemas/assets.v1.json +61 -0
package/schemas/block.v1.json +27 -0
package/schemas/blocks/brief.v1.json +20 -0
package/schemas/blocks/callout.v1.json +25 -0
package/schemas/blocks/code.v1.json +21 -0
package/schemas/blocks/decision.v1.json +80 -0
package/schemas/blocks/evidence-comparison.v1.json +33 -0
package/schemas/blocks/example.v1.json +52 -0
package/schemas/blocks/figure.v1.json +22 -0
package/schemas/blocks/human-action.v1.json +42 -0
package/schemas/blocks/job-map.v1.json +170 -0
package/schemas/blocks/pause.v1.json +25 -0
package/schemas/blocks/reference-profile.v1.json +41 -0
package/schemas/blocks/review-checklist.v1.json +19 -0
package/schemas/blocks/table.v1.json +59 -0
package/schemas/brief.v1.json +157 -0
package/schemas/build-request.v1.json +173 -0
package/schemas/build-result.v1.json +171 -0
package/schemas/checks.v1.json +149 -0
package/schemas/create-request.v1.json +47 -0
package/schemas/diagnostic.v1.json +50 -0
package/schemas/draft-request.v1.json +196 -0
package/schemas/guide.v1.json +172 -0
package/schemas/job.v1.json +107 -0
package/schemas/preview-request.v1.json +153 -0
package/schemas/preview-result.v1.json +84 -0
package/schemas/problem.v1.json +78 -0
package/schemas/recipe-definition.v1.json +673 -0
package/schemas/source-ref.v1.json +111 -0
package/schemas/sources.v1.json +158 -0
package/schemas/validate-request.v1.json +135 -0
package/schemas/validate-result.v1.json +110 -0
package/schemas/verification.v1.json +77 -0
package/themes/book/1.0.0/theme.css +190 -0
package/themes/book/1.0.0/theme.json +5 -0

package/schemas/source-ref.v1.json ADDED Viewed

@@ -0,0 +1,111 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/source-ref.v1.json",
+  "title": "Source reference",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "path"
+        },
+        "path": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": [
+        "kind",
+        "path"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "files"
+        },
+        "files": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "encoding": {
+                    "type": "string",
+                    "enum": [
+                      "utf8",
+                      "base64"
+                    ]
+                  },
+                  "content": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "encoding",
+                  "content"
+                ],
+                "additionalProperties": false
+              }
+            ]
+          }
+        }
+      },
+      "required": [
+        "kind",
+        "files"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "zip"
+        },
+        "base64": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "required": [
+        "kind",
+        "base64"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "guide"
+        },
+        "guideId": {
+          "type": "string",
+          "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
+        },
+        "revision": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "kind",
+        "guideId"
+      ],
+      "additionalProperties": false
+    }
+  ]
+}

package/schemas/sources.v1.json ADDED Viewed

@@ -0,0 +1,158 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/sources.v1.json",
+  "title": "sources.yaml",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+$"
+    },
+    "sources": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
+          },
+          "title": {
+            "type": "string",
+            "minLength": 1
+          },
+          "kind": {
+            "type": "string",
+            "enum": [
+              "document",
+              "dataset",
+              "web",
+              "registry",
+              "repository",
+              "interview",
+              "other"
+            ]
+          },
+          "version": {
+            "type": "string",
+            "minLength": 1
+          },
+          "locator": {
+            "type": "string",
+            "minLength": 1
+          },
+          "synthetic": {
+            "type": "boolean"
+          },
+          "visibility": {
+            "type": "string",
+            "enum": [
+              "private",
+              "public"
+            ]
+          },
+          "digest": {
+            "type": "string",
+            "pattern": "^sha256:[0-9a-f]{64}$"
+          },
+          "note": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "title",
+          "version",
+          "locator"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "claims": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
+          },
+          "text": {
+            "type": "string",
+            "minLength": 1
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "supported",
+              "unresolved"
+            ]
+          },
+          "evidence": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "source": {
+                  "type": "string",
+                  "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
+                },
+                "locator": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "source"
+              ],
+              "additionalProperties": false
+            }
+          }
+        },
+        "required": [
+          "id",
+          "text"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "checkEvidence": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "check": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
+          },
+          "evidence": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "source": {
+                  "type": "string",
+                  "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
+                },
+                "locator": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "source"
+              ],
+              "additionalProperties": false
+            }
+          }
+        },
+        "required": [
+          "check"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "schemaVersion"
+  ],
+  "additionalProperties": false
+}

package/schemas/validate-request.v1.json ADDED Viewed

@@ -0,0 +1,135 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/validate-request.v1.json",
+  "title": "Validate request",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "source": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "path"
+            },
+            "path": {
+              "type": "string",
+              "minLength": 1
+            }
+          },
+          "required": [
+            "kind",
+            "path"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "files"
+            },
+            "files": {
+              "type": "object",
+              "propertyNames": {
+                "type": "string"
+              },
+              "additionalProperties": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "encoding": {
+                        "type": "string",
+                        "enum": [
+                          "utf8",
+                          "base64"
+                        ]
+                      },
+                      "content": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "encoding",
+                      "content"
+                    ],
+                    "additionalProperties": false
+                  }
+                ]
+              }
+            }
+          },
+          "required": [
+            "kind",
+            "files"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "zip"
+            },
+            "base64": {
+              "type": "string",
+              "minLength": 1
+            }
+          },
+          "required": [
+            "kind",
+            "base64"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "guide"
+            },
+            "guideId": {
+              "type": "string",
+              "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
+            },
+            "revision": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "kind",
+            "guideId"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "mode": {
+      "default": "draft",
+      "type": "string",
+      "enum": [
+        "draft",
+        "release"
+      ]
+    },
+    "audience": {
+      "type": "string",
+      "enum": [
+        "private",
+        "public"
+      ]
+    }
+  },
+  "required": [
+    "source"
+  ],
+  "additionalProperties": false
+}

package/schemas/validate-result.v1.json ADDED Viewed

@@ -0,0 +1,110 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/validate-result.v1.json",
+  "title": "Validate result",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "ok": {
+      "type": "boolean"
+    },
+    "mode": {
+      "type": "string",
+      "enum": [
+        "draft",
+        "release"
+      ]
+    },
+    "guideId": {
+      "type": "string"
+    },
+    "revision": {
+      "type": "string"
+    },
+    "referenceRevision": {
+      "type": "string"
+    },
+    "summary": {
+      "type": "object",
+      "properties": {
+        "errors": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        "warnings": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        "infos": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        }
+      },
+      "required": [
+        "errors",
+        "warnings",
+        "infos"
+      ],
+      "additionalProperties": false
+    },
+    "diagnostics": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string"
+          },
+          "severity": {
+            "type": "string",
+            "enum": [
+              "error",
+              "warning",
+              "info"
+            ]
+          },
+          "path": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          },
+          "line": {
+            "type": "integer",
+            "exclusiveMinimum": 0,
+            "maximum": 9007199254740991
+          },
+          "column": {
+            "type": "integer",
+            "exclusiveMinimum": 0,
+            "maximum": 9007199254740991
+          },
+          "blockId": {
+            "type": "string"
+          },
+          "pointer": {
+            "type": "string"
+          },
+          "hint": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "code",
+          "severity",
+          "path",
+          "message"
+        ]
+      }
+    }
+  },
+  "required": [
+    "ok",
+    "mode",
+    "summary",
+    "diagnostics"
+  ],
+  "additionalProperties": false
+}

package/schemas/verification.v1.json ADDED Viewed

@@ -0,0 +1,77 @@
+{
+  "$id": "https://x12i.dev/made-easy/schemas/verification.v1.json",
+  "title": "operator/fixtures/verification.yaml",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schemaVersion": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+$"
+    },
+    "records": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "example": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
+          },
+          "digest": {
+            "type": "string",
+            "pattern": "^sha256:[0-9a-f]{64}$"
+          },
+          "result": {
+            "type": "string",
+            "enum": [
+              "pass",
+              "fail"
+            ]
+          },
+          "runtime": {
+            "type": "string"
+          },
+          "verifier": {
+            "type": "object",
+            "properties": {
+              "kind": {
+                "type": "string",
+                "enum": [
+                  "ci",
+                  "sandbox",
+                  "manual"
+                ]
+              },
+              "ref": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "kind",
+              "ref"
+            ],
+            "additionalProperties": false
+          },
+          "recordedAt": {
+            "type": "string"
+          },
+          "output": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "example",
+          "digest",
+          "result",
+          "verifier"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "schemaVersion"
+  ],
+  "additionalProperties": false
+}