@asturiu/v0-sdk 0.0.0-stage → 1.0.0

package/contract/schemas/definitions.schema.json

@@ -0,0 +1,376 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://asturiu.com/contract/v0/definitions.schema.json",
+  "title": "A Tenant's Definition set",
+  "description": "Structure only (ADR-074 §10): the Engine stays the judge, and a set that passes may still be refused when it is planned. Written by scripts/contract.mjs.",
+  "type": "object",
+  "required": [
+    "wallets"
+  ],
+  "properties": {
+    "$comment": {
+      "type": "string"
+    },
+    "shared_fields": {
+      "type": "object",
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9_]{0,62}$"
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/field"
+      }
+    },
+    "shared_entries": {
+      "type": "object",
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9_]{0,62}$"
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/entry"
+      }
+    },
+    "wallets": {
+      "type": "object",
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9_]{0,62}$"
+      },
+      "additionalProperties": {
+        "$ref": "#/$defs/wallet"
+      }
+    },
+    "acknowledge": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "field": {
+      "type": "object",
+      "required": [
+        "value_type"
+      ],
+      "properties": {
+        "label": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "value_type": {
+          "enum": [
+            "text",
+            "password",
+            "number",
+            "boolean",
+            "date",
+            "datetime",
+            "email",
+            "phone",
+            "url",
+            "json",
+            "attachment"
+          ]
+        },
+        "validation": {
+          "type": "object"
+        },
+        "secret": {
+          "type": "boolean"
+        },
+        "reveal": {
+          "enum": [
+            "visible",
+            "click",
+            "captcha",
+            "password",
+            "2fa"
+          ]
+        },
+        "searchable": {
+          "type": "boolean"
+        },
+        "immutable": {
+          "type": "boolean"
+        },
+        "locked": {
+          "type": "boolean"
+        },
+        "filled_by": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "value",
+              "internal",
+              "external"
+            ]
+          }
+        },
+        "targets": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "target_definitions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "locator": {
+          "type": "object"
+        }
+      },
+      "additionalProperties": false
+    },
+    "entryField": {
+      "anyOf": [
+        {
+          "type": "object",
+          "required": [
+            "use"
+          ],
+          "properties": {
+            "use": {
+              "type": "string",
+              "pattern": "^[a-z][a-z0-9_]{0,62}$"
+            },
+            "filled_by": {
+              "type": "array",
+              "items": {
+                "enum": [
+                  "value",
+                  "internal",
+                  "external"
+                ]
+              }
+            },
+            "required": {
+              "type": "boolean"
+            },
+            "order": {
+              "type": "integer"
+            },
+            "fill_in": {}
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "value_type"
+          ],
+          "properties": {
+            "label": {
+              "type": "string"
+            },
+            "description": {
+              "type": "string"
+            },
+            "value_type": {
+              "enum": [
+                "text",
+                "password",
+                "number",
+                "boolean",
+                "date",
+                "datetime",
+                "email",
+                "phone",
+                "url",
+                "json",
+                "attachment"
+              ]
+            },
+            "validation": {
+              "type": "object"
+            },
+            "secret": {
+              "type": "boolean"
+            },
+            "reveal": {
+              "enum": [
+                "visible",
+                "click",
+                "captcha",
+                "password",
+                "2fa"
+              ]
+            },
+            "searchable": {
+              "type": "boolean"
+            },
+            "immutable": {
+              "type": "boolean"
+            },
+            "locked": {
+              "type": "boolean"
+            },
+            "filled_by": {
+              "type": "array",
+              "items": {
+                "enum": [
+                  "value",
+                  "internal",
+                  "external"
+                ]
+              }
+            },
+            "targets": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "target_definitions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "locator": {
+              "type": "object"
+            },
+            "required": {
+              "type": "boolean"
+            },
+            "order": {
+              "type": "integer"
+            },
+            "fill_in": {}
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "entry": {
+      "type": "object",
+      "required": [
+        "fields"
+      ],
+      "properties": {
+        "label": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "kind": {
+          "enum": [
+            "file",
+            "folder"
+          ]
+        },
+        "nestable": {
+          "type": "boolean"
+        },
+        "contains": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[a-z][a-z0-9_]{0,62}$"
+          }
+        },
+        "customizable": {
+          "type": "boolean"
+        },
+        "value_types": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "text",
+              "password",
+              "number",
+              "boolean",
+              "date",
+              "datetime",
+              "email",
+              "phone",
+              "url",
+              "json",
+              "attachment"
+            ]
+          }
+        },
+        "secret_reveal_min": {
+          "enum": [
+            "visible",
+            "click",
+            "captcha",
+            "password",
+            "2fa"
+          ]
+        },
+        "custom_filled_by": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "value",
+              "internal",
+              "external"
+            ]
+          }
+        },
+        "fields": {
+          "type": "object",
+          "propertyNames": {
+            "pattern": "^[a-z][a-z0-9_]{0,62}$"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/entryField"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "wallet": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "entries": {
+          "type": "object",
+          "propertyNames": {
+            "pattern": "^[a-z][a-z0-9_]{0,62}$"
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/entry"
+          }
+        },
+        "accepts": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^[a-z][a-z0-9_]{0,62}$"
+          }
+        },
+        "nestable": {
+          "type": "boolean"
+        },
+        "immutable": {
+          "type": "boolean"
+        },
+        "metering": {
+          "enum": [
+            "storage",
+            "events"
+          ]
+        },
+        "event_retention_days": {
+          "type": "integer"
+        },
+        "default_policy": {
+          "type": "object"
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/contract/schemas/portal.schema.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://asturiu.com/contract/v0/portal.schema.json",
+  "title": "A Tenant's portal options",
+  "description": "Structure only (ADR-074 §10): what PUT /tenant/v0/portal takes. A switch left out is on; a page left out is back to its default. Written by scripts/contract.mjs.",
+  "type": "object",
+  "properties": {
+    "$comment": {
+      "type": "string"
+    },
+    "account_link": {
+      "type": "boolean"
+    },
+    "open_app": {
+      "type": "boolean"
+    },
+    "back_link": {
+      "type": "boolean"
+    },
+    "language_menu": {
+      "type": "boolean"
+    },
+    "appearance": {
+      "type": "boolean"
+    },
+    "pages": {
+      "type": "object",
+      "propertyNames": {
+        "enum": [
+          "profile",
+          "security",
+          "plan",
+          "privacy",
+          "recovery",
+          "support"
+        ]
+      },
+      "additionalProperties": {
+        "type": "object",
+        "required": [
+          "mode"
+        ],
+        "properties": {
+          "mode": {
+            "enum": [
+              "portal",
+              "off"
+            ]
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/contract/tenant-api-routes.json

@@ -0,0 +1,165 @@
+{
+  "$comment": "Every Tenant API route with the scope a key needs (null: any live key). Written from TENANT_API_ROUTES by scripts/contract.mjs; do not edit.",
+  "routes": [
+    {
+      "method": "POST",
+      "path": "/tenant/v0/definitions",
+      "scope": "definitions"
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/definitions/status",
+      "scope": "definitions"
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/branding",
+      "scope": "branding"
+    },
+    {
+      "method": "PUT",
+      "path": "/tenant/v0/branding",
+      "scope": "branding"
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/portal",
+      "scope": "portal"
+    },
+    {
+      "method": "PUT",
+      "path": "/tenant/v0/portal",
+      "scope": "portal"
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/tiers",
+      "scope": "tiers"
+    },
+    {
+      "method": "PUT",
+      "path": "/tenant/v0/tiers",
+      "scope": "tiers"
+    },
+    {
+      "method": "PUT",
+      "path": "/tenant/v0/customers/:cst/entitlement",
+      "scope": "entitlements"
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/customers/:cst/entitlements",
+      "scope": "entitlements"
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/subscription",
+      "scope": null
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/tags",
+      "scope": "tags"
+    },
+    {
+      "method": "PUT",
+      "path": "/tenant/v0/tags/:name",
+      "scope": "tags"
+    },
+    {
+      "method": "PUT",
+      "path": "/tenant/v0/customers/:cst/tags/:name",
+      "scope": "tags"
+    },
+    {
+      "method": "DELETE",
+      "path": "/tenant/v0/customers/:cst/tags/:name",
+      "scope": "tags"
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/engine",
+      "scope": null
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/key",
+      "scope": null
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/changesets",
+      "scope": null
+    },
+    {
+      "method": "PUT",
+      "path": "/tenant/v0/changesets/:n/status",
+      "scope": null
+    },
+    {
+      "method": "POST",
+      "path": "/tenant/v0/feedback",
+      "scope": null
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/feedback",
+      "scope": null
+    },
+    {
+      "method": "POST",
+      "path": "/tenant/v0/feedback/:tkt/posts",
+      "scope": null
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/tickets",
+      "scope": "tickets"
+    },
+    {
+      "method": "POST",
+      "path": "/tenant/v0/tickets",
+      "scope": "tickets"
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/tickets/:tkt",
+      "scope": "tickets"
+    },
+    {
+      "method": "PATCH",
+      "path": "/tenant/v0/tickets/:tkt",
+      "scope": "tickets"
+    },
+    {
+      "method": "POST",
+      "path": "/tenant/v0/tickets/:tkt/posts",
+      "scope": "tickets"
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/announcements",
+      "scope": "tickets"
+    },
+    {
+      "method": "POST",
+      "path": "/tenant/v0/announcements",
+      "scope": "tickets"
+    },
+    {
+      "method": "GET",
+      "path": "/tenant/v0/announcements/:tkt",
+      "scope": "tickets"
+    },
+    {
+      "method": "PATCH",
+      "path": "/tenant/v0/announcements/:tkt",
+      "scope": "tickets"
+    },
+    {
+      "method": "DELETE",
+      "path": "/tenant/v0/announcements/:tkt",
+      "scope": "tickets"
+    }
+  ]
+}