@jxsuite/connector 0.1.0

package/src/Supabase.class.json

@@ -0,0 +1,81 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jxsuite.com/schemas/connector/Supabase.class.json",
+  "title": "Supabase",
+  "description": "Supabase (postgres) connection provider over postgres-js; from Workers via a Hyperdrive binding, elsewhere via the urlEnv-named connection URL",
+  "$prototype": "Class",
+  "extends": "Object",
+  "$implementation": "./supabase.js",
+
+  "connector": {
+    "provider": "supabase",
+    "kind": "postgres",
+    "serve": "@jxsuite/connector/worker",
+    "module": "@jxsuite/connector/supabase"
+  },
+
+  "$defs": {
+    "methods": {
+      "dialect": {
+        "role": "dialect",
+        "$prototype": "Function",
+        "access": "public",
+        "scope": "static",
+        "identifier": "dialect",
+        "timing": ["compiler", "server"],
+        "parameters": [
+          { "identifier": "connection", "type": { "type": "object" } },
+          { "identifier": "env", "type": { "type": "object" } }
+        ],
+        "returnType": { "type": "object" },
+        "description": "Kysely postgres-js dialect: Hyperdrive binding first, then the urlEnv-named env var"
+      },
+      "deploySchema": {
+        "role": "deploySchema",
+        "$prototype": "Function",
+        "access": "public",
+        "scope": "static",
+        "identifier": "deploySchema",
+        "timing": ["compiler", "server"],
+        "parameters": [
+          { "identifier": "tables", "type": { "type": "object" } },
+          { "identifier": "connection", "type": { "type": "object" } },
+          {
+            "identifier": "options",
+            "type": {
+              "type": "object",
+              "properties": { "env": { "type": "object" }, "dryRun": { "type": "boolean" } }
+            }
+          }
+        ],
+        "returnType": { "type": "object" },
+        "description": "Additive schema sync: { statements, applied, warnings }"
+      },
+      "bindings": {
+        "role": "bindings",
+        "$prototype": "Function",
+        "access": "public",
+        "scope": "static",
+        "identifier": "bindings",
+        "timing": ["compiler", "server"],
+        "parameters": [{ "identifier": "connection", "type": { "type": "object" } }],
+        "returnType": { "type": "object" },
+        "description": "Wrangler config fragment: the hyperdrive binding when hyperdriveId is set"
+      },
+      "testConnection": {
+        "role": "testConnection",
+        "$prototype": "Function",
+        "access": "public",
+        "scope": "static",
+        "identifier": "testConnection",
+        "timing": ["compiler", "server"],
+        "parameters": [
+          { "identifier": "connection", "type": { "type": "object" } },
+          { "identifier": "env", "type": { "type": "object" } }
+        ],
+        "returnType": { "type": "object" },
+        "description": "Probe the connection with `select 1`: { ok, error? }"
+      }
+    }
+  }
+}

package/src/TableDelete.class.json

@@ -0,0 +1,56 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jxsuite.com/schemas/connector/TableDelete.class.json",
+  "title": "TableDelete",
+  "description": "Delete action: DELETE /_jx/data/<table>/<id> (id: literal, ${...} template, or #/$params ref); lowered to an inline Function handler in compiled sites",
+  "$prototype": "Class",
+  "extends": "Object",
+  "$implementation": "./table-delete.js",
+
+  "$studio": {
+    "stateDefaults": { "timing": "client" }
+  },
+
+  "$defs": {
+    "parameters": {
+      "table": {
+        "identifier": "table",
+        "type": { "type": "string" },
+        "description": "Name of a `data` section table"
+      },
+      "id": {
+        "identifier": "id",
+        "type": { "type": ["string", "integer", "object"] },
+        "description": "Row id: a literal, a ${...} template, or { \"$ref\": \"#/$params/<name>\" }"
+      }
+    },
+    "constructor": {
+      "role": "constructor",
+      "parameters": [{ "$ref": "#/$defs/parameters/table" }, { "$ref": "#/$defs/parameters/id" }],
+      "body": ["this.config = config;"]
+    },
+    "methods": {
+      "resolve": {
+        "role": "method",
+        "scope": "instance",
+        "identifier": "resolve",
+        "returnType": { "type": "object" },
+        "description": "An event handler performing the delete and bumping state._v"
+      },
+      "lower": {
+        "role": "lower",
+        "$prototype": "Function",
+        "access": "public",
+        "scope": "static",
+        "identifier": "lower",
+        "timing": ["compiler"],
+        "parameters": [
+          { "identifier": "def", "type": { "type": "object" } },
+          { "identifier": "context", "type": { "type": "object" } }
+        ],
+        "returnType": { "type": "object" },
+        "description": "Rewrite into an inline Function def fetching DELETE /_jx/data/<table>/<id>"
+      }
+    }
+  }
+}

package/src/TableEntry.class.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jxsuite.com/schemas/connector/TableEntry.class.json",
+  "title": "TableEntry",
+  "description": "One row of a dynamic table by id — `#/$params/<name>` refs resolve against the route; lowered to a core Request def in compiled sites",
+  "$prototype": "Class",
+  "extends": "Object",
+  "$implementation": "./table-state.js",
+
+  "$studio": {
+    "stateDefaults": { "timing": "client" }
+  },
+
+  "$defs": {
+    "parameters": {
+      "table": {
+        "identifier": "table",
+        "type": { "type": "string" },
+        "description": "Name of a `data` section table"
+      },
+      "id": {
+        "identifier": "id",
+        "type": { "type": ["string", "integer", "object"] },
+        "description": "Row id: a literal, a ${...} template, or { \"$ref\": \"#/$params/<name>\" }"
+      },
+      "include": {
+        "identifier": "include",
+        "type": { "type": ["array", "string"] },
+        "description": "Reference fields to expand"
+      }
+    },
+    "constructor": {
+      "role": "constructor",
+      "parameters": [
+        { "$ref": "#/$defs/parameters/table" },
+        { "$ref": "#/$defs/parameters/id" },
+        { "$ref": "#/$defs/parameters/include" }
+      ],
+      "body": ["this.config = config;"]
+    },
+    "methods": {
+      "resolve": {
+        "role": "method",
+        "scope": "instance",
+        "identifier": "resolve",
+        "returnType": { "type": "object" },
+        "description": "The row, or null"
+      },
+      "lower": {
+        "role": "lower",
+        "$prototype": "Function",
+        "access": "public",
+        "scope": "static",
+        "identifier": "lower",
+        "timing": ["compiler"],
+        "parameters": [
+          { "identifier": "def", "type": { "type": "object" } },
+          { "identifier": "context", "type": { "type": "object" } }
+        ],
+        "returnType": { "type": "object" },
+        "description": "Rewrite into a core Request def for one row (route params substituted at lower time)"
+      }
+    }
+  }
+}

package/src/TableInsert.class.json

@@ -0,0 +1,59 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jxsuite.com/schemas/connector/TableInsert.class.json",
+  "title": "TableInsert",
+  "description": "Insert action: POST a row to /_jx/data/<table> from a form submit (FormData merged under literal values); lowered to an inline Function handler in compiled sites",
+  "$prototype": "Class",
+  "extends": "Object",
+  "$implementation": "./table-insert.js",
+
+  "$studio": {
+    "stateDefaults": { "timing": "client" }
+  },
+
+  "$defs": {
+    "parameters": {
+      "table": {
+        "identifier": "table",
+        "type": { "type": "string" },
+        "description": "Name of a `data` section table"
+      },
+      "values": {
+        "identifier": "values",
+        "type": { "type": "object" },
+        "description": "Literal payload columns merged over the submitting form's FormData"
+      }
+    },
+    "constructor": {
+      "role": "constructor",
+      "parameters": [
+        { "$ref": "#/$defs/parameters/table" },
+        { "$ref": "#/$defs/parameters/values" }
+      ],
+      "body": ["this.config = config;"]
+    },
+    "methods": {
+      "resolve": {
+        "role": "method",
+        "scope": "instance",
+        "identifier": "resolve",
+        "returnType": { "type": "object" },
+        "description": "An event handler performing the insert and bumping state._v"
+      },
+      "lower": {
+        "role": "lower",
+        "$prototype": "Function",
+        "access": "public",
+        "scope": "static",
+        "identifier": "lower",
+        "timing": ["compiler"],
+        "parameters": [
+          { "identifier": "def", "type": { "type": "object" } },
+          { "identifier": "context", "type": { "type": "object" } }
+        ],
+        "returnType": { "type": "object" },
+        "description": "Rewrite into an inline Function def fetching POST /_jx/data/<table>"
+      }
+    }
+  }
+}

package/src/TableQuery.class.json

@@ -0,0 +1,75 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jxsuite.com/schemas/connector/TableQuery.class.json",
+  "title": "TableQuery",
+  "description": "Rows of a dynamic table matching a content-grammar filter/sort/limit — fetched from /_jx/data in browsers, read directly under node, and lowered to a core Request def in compiled sites",
+  "$prototype": "Class",
+  "extends": "Object",
+  "$implementation": "./table-state.js",
+
+  "$studio": {
+    "stateDefaults": { "timing": "client" }
+  },
+
+  "$defs": {
+    "parameters": {
+      "table": {
+        "identifier": "table",
+        "type": { "type": "string" },
+        "description": "Name of a `data` section table"
+      },
+      "filter": {
+        "identifier": "filter",
+        "type": { "type": ["array", "object"] },
+        "description": "Content filter grammar: rule array [{ field, op, value }] or equality-object shorthand"
+      },
+      "sort": {
+        "identifier": "sort",
+        "type": { "type": ["array", "object"] },
+        "description": "Sort rule { field, order } or a list of them"
+      },
+      "limit": { "identifier": "limit", "type": { "type": "integer" } },
+      "offset": { "identifier": "offset", "type": { "type": "integer" } },
+      "include": {
+        "identifier": "include",
+        "type": { "type": ["array", "string"] },
+        "description": "Reference fields to expand (to-one table refs and junction to-many fields)"
+      }
+    },
+    "constructor": {
+      "role": "constructor",
+      "parameters": [
+        { "$ref": "#/$defs/parameters/table" },
+        { "$ref": "#/$defs/parameters/filter" },
+        { "$ref": "#/$defs/parameters/sort" },
+        { "$ref": "#/$defs/parameters/limit" },
+        { "$ref": "#/$defs/parameters/offset" },
+        { "$ref": "#/$defs/parameters/include" }
+      ],
+      "body": ["this.config = config;"]
+    },
+    "methods": {
+      "resolve": {
+        "role": "method",
+        "scope": "instance",
+        "identifier": "resolve",
+        "returnType": { "type": "array" },
+        "description": "The matching rows"
+      },
+      "lower": {
+        "role": "lower",
+        "$prototype": "Function",
+        "access": "public",
+        "scope": "static",
+        "identifier": "lower",
+        "timing": ["compiler"],
+        "parameters": [
+          { "identifier": "def", "type": { "type": "object" } },
+          { "identifier": "context", "type": { "type": "object" } }
+        ],
+        "returnType": { "type": "object" },
+        "description": "Rewrite into a core Request def: /_jx/data URL with preserved template placeholders plus the `_v` read-after-write param"
+      }
+    }
+  }
+}

package/src/TableUpdate.class.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jxsuite.com/schemas/connector/TableUpdate.class.json",
+  "title": "TableUpdate",
+  "description": "Update action: PATCH a row at /_jx/data/<table>/<id> (id: literal, ${...} template, or #/$params ref); lowered to an inline Function handler in compiled sites",
+  "$prototype": "Class",
+  "extends": "Object",
+  "$implementation": "./table-update.js",
+
+  "$studio": {
+    "stateDefaults": { "timing": "client" }
+  },
+
+  "$defs": {
+    "parameters": {
+      "table": {
+        "identifier": "table",
+        "type": { "type": "string" },
+        "description": "Name of a `data` section table"
+      },
+      "id": {
+        "identifier": "id",
+        "type": { "type": ["string", "integer", "object"] },
+        "description": "Row id: a literal, a ${...} template, or { \"$ref\": \"#/$params/<name>\" }"
+      },
+      "values": {
+        "identifier": "values",
+        "type": { "type": "object" },
+        "description": "Literal payload columns merged over the submitting form's FormData"
+      }
+    },
+    "constructor": {
+      "role": "constructor",
+      "parameters": [
+        { "$ref": "#/$defs/parameters/table" },
+        { "$ref": "#/$defs/parameters/id" },
+        { "$ref": "#/$defs/parameters/values" }
+      ],
+      "body": ["this.config = config;"]
+    },
+    "methods": {
+      "resolve": {
+        "role": "method",
+        "scope": "instance",
+        "identifier": "resolve",
+        "returnType": { "type": "object" },
+        "description": "An event handler performing the update and bumping state._v"
+      },
+      "lower": {
+        "role": "lower",
+        "$prototype": "Function",
+        "access": "public",
+        "scope": "static",
+        "identifier": "lower",
+        "timing": ["compiler"],
+        "parameters": [
+          { "identifier": "def", "type": { "type": "object" } },
+          { "identifier": "context", "type": { "type": "object" } }
+        ],
+        "returnType": { "type": "object" },
+        "description": "Rewrite into an inline Function def fetching PATCH /_jx/data/<table>/<id>"
+      }
+    }
+  }
+}