@squiz/dx-json-schema-lib 1.85.1 → 1.85.3

package/src/manifest/userApi/v1/UserApiManifestV1.json

@@ -0,0 +1,77 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+  "title": "UserApiManifestV1",
+  "type": "object",
+  "additionalProperties": false,
+  "definitions": {
+    "resolvedApiManifest": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["endpoints"],
+      "properties": {
+        "endpoints": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["path", "method", "handler"],
+            "properties": {
+              "path": {
+                "type": "string",
+                "pattern": "^/.*",
+                "description": "URL path routed to this endpoint; must start with /. May include `*` wildcards or `:param` segments (api-builder style)."
+              },
+              "method": {
+                "type": "string",
+                "enum": ["GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD"],
+                "description": "HTTP method for this route."
+              },
+              "handler": {
+                "type": "string",
+                "pattern": "^[a-zA-Z_$][a-zA-Z0-9_$.]*$",
+                "description": "Exported handler reference (module.export form)."
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "required": ["$schema", "name", "displayName", "filesDir", "entry", "manifest"],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "minLength": 1,
+      "description": "JSON Schema reference for IDE support."
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[a-z](?:[a-z0-9-]|_(?!_))*[a-z0-9]$",
+      "description": "Slug for this deployment. Lowercase letters, digits, hyphens, or underscores only; must start with a letter, end with a letter or digit, and cannot contain consecutive underscores."
+    },
+    "displayName": {
+      "type": "string",
+      "minLength": 1
+    },
+    "description": {
+      "type": "string",
+      "description": "Human-readable summary of what the API provides."
+    },
+    "filesDir": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Directory (relative to the manifest) containing sources."
+    },
+    "entry": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Entry module path under filesDir (e.g. index.ts)."
+    },
+    "manifest": {
+      "$ref": "#/definitions/resolvedApiManifest"
+    }
+  }
+}

package/src/manifest/userApi/v1/UserApiManifestV1.ts

@@ -0,0 +1,50 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface UserApiManifestV1 {
+  /**
+   * JSON Schema reference for IDE support.
+   */
+  $schema: string;
+  /**
+   * Slug for this deployment. Lowercase letters, digits, hyphens, or underscores only; must start with a letter, end with a letter or digit, and cannot contain consecutive underscores.
+   */
+  name: string;
+  displayName: string;
+  /**
+   * Human-readable summary of what the API provides.
+   */
+  description?: string;
+  /**
+   * Directory (relative to the manifest) containing sources.
+   */
+  filesDir: string;
+  /**
+   * Entry module path under filesDir (e.g. index.ts).
+   */
+  entry: string;
+  manifest: ResolvedApiManifest;
+}
+export interface ResolvedApiManifest {
+  /**
+   * @minItems 1
+   */
+  endpoints: {
+    /**
+     * URL path routed to this endpoint; must start with /. May include `*` wildcards or `:param` segments (api-builder style).
+     */
+    path: string;
+    /**
+     * HTTP method for this route.
+     */
+    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+    /**
+     * Exported handler reference (module.export form).
+     */
+    handler: string;
+  }[];
+}

package/src/manifest/userApi/v1/index.ts

@@ -0,0 +1,6 @@
+export {
+  USER_API_FULL_MANIFEST_SCHEMA,
+  USER_API_MANIFEST_SCHEMA_URL,
+  validateUserApiFullManifest,
+} from './userApiManifestValidation';
+export type { UserApiManifestV1 as UserApiManifest } from './UserApiManifestV1';

package/src/manifest/userApi/v1/integration-fixtures/invalid-endpoint-extra-public.manifest.json

@@ -0,0 +1,10 @@
+{
+  "endpoints": [
+    {
+      "path": "/ok",
+      "method": "GET",
+      "handler": "noop",
+      "public": true
+    }
+  ]
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-endpoint-handler-hyphen.manifest.json

@@ -0,0 +1,9 @@
+{
+  "endpoints": [
+    {
+      "path": "/ok",
+      "method": "GET",
+      "handler": "bad-name"
+    }
+  ]
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-endpoint-handler-leading-digit.manifest.json

@@ -0,0 +1,9 @@
+{
+  "endpoints": [
+    {
+      "path": "/ok",
+      "method": "GET",
+      "handler": "0badIdentifier"
+    }
+  ]
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-endpoint-method-invalid.manifest.json

@@ -0,0 +1,9 @@
+{
+  "endpoints": [
+    {
+      "path": "/ok",
+      "method": "TRACE",
+      "handler": "noop"
+    }
+  ]
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-endpoint-missing-method.manifest.json

@@ -0,0 +1,8 @@
+{
+  "endpoints": [
+    {
+      "path": "/ok",
+      "handler": "noop"
+    }
+  ]
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-endpoint-missing-path.manifest.json

@@ -0,0 +1,8 @@
+{
+  "endpoints": [
+    {
+      "method": "GET",
+      "handler": "noop"
+    }
+  ]
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-full-displayName-empty.manifest.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+  "name": "needs-display-name",
+  "displayName": "",
+  "filesDir": "src",
+  "entry": "index.ts",
+  "manifest": {
+    "endpoints": [
+      {
+        "path": "/only",
+        "method": "GET",
+        "handler": "h"
+      }
+    ]
+  }
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-full-manifest-not-object.manifest.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+  "name": "bad-manifest-shape",
+  "displayName": "Manifest not an object",
+  "filesDir": "src",
+  "entry": "index.ts",
+  "manifest": "not-an-object"
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-full-missing-manifest.manifest.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+  "name": "missing-nested-manifest",
+  "displayName": "Manifest object absent",
+  "filesDir": "src",
+  "entry": "index.ts"
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-full-missing-schema.manifest.json

@@ -0,0 +1,15 @@
+{
+  "name": "missing-dollar-schema",
+  "displayName": "Missing dollar schema field",
+  "filesDir": "src",
+  "entry": "index.ts",
+  "manifest": {
+    "endpoints": [
+      {
+        "path": "/only",
+        "method": "GET",
+        "handler": "h"
+      }
+    ]
+  }
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-full-name-empty.manifest.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+  "name": "",
+  "displayName": "Empty slug",
+  "filesDir": "src",
+  "entry": "index.ts",
+  "manifest": {
+    "endpoints": [
+      {
+        "path": "/only",
+        "method": "GET",
+        "handler": "h"
+      }
+    ]
+  }
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-full-root-extra-property.manifest.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+  "name": "extra-root-prop",
+  "displayName": "Extra root prop",
+  "filesDir": "src",
+  "entry": "index.ts",
+  "manifest": {
+    "endpoints": [
+      {
+        "path": "/only",
+        "method": "GET",
+        "handler": "h"
+      }
+    ]
+  },
+  "telemetryChannel": "forbidden-root-key-example"
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-nested-manifest-handlerMap.manifest.json

@@ -0,0 +1,12 @@
+{
+  "endpoints": [
+    {
+      "path": "/ok",
+      "method": "GET",
+      "handler": "noop"
+    }
+  ],
+  "handlerMap": {
+    "noop": "./noop.ts"
+  }
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-nested-manifest-name.manifest.json

@@ -0,0 +1,10 @@
+{
+  "name": "must-not-live-under-manifest",
+  "endpoints": [
+    {
+      "path": "/ok",
+      "method": "GET",
+      "handler": "noop"
+    }
+  ]
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-resolved-empty-endpoints.manifest.json

@@ -0,0 +1,4 @@
+{
+  "name": "integration-sample-api",
+  "endpoints": []
+}

package/src/manifest/userApi/v1/integration-fixtures/invalid-resolved-no-leading-slash.manifest.json

@@ -0,0 +1,11 @@
+{
+  "name": "integration-sample-api",
+  "endpoints": [
+    {
+      "path": "needs-leading-slash",
+      "method": "GET",
+      "handler": "index.x",
+      "public": true
+    }
+  ]
+}

package/src/manifest/userApi/v1/integration-fixtures/valid-full-each-http-method.manifest.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+  "name": "all-methods-api",
+  "displayName": "Covers enum methods",
+  "filesDir": "src",
+  "entry": "index.ts",
+  "manifest": {
+    "endpoints": [
+      { "path": "/g", "method": "GET", "handler": "handlers.g" },
+      { "path": "/po", "method": "POST", "handler": "handlers.po" },
+      { "path": "/pu", "method": "PUT", "handler": "handlers.pu" },
+      { "path": "/pa", "method": "PATCH", "handler": "handlers.pa" },
+      { "path": "/d", "method": "DELETE", "handler": "handlers.d" },
+      { "path": "/o", "method": "OPTIONS", "handler": "handlers.o" },
+      { "path": "/h", "method": "HEAD", "handler": "handlers.h" }
+    ]
+  }
+}

package/src/manifest/userApi/v1/integration-fixtures/valid-full-no-description.manifest.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+  "name": "no-description-api",
+  "displayName": "No optional description field",
+  "filesDir": "src",
+  "entry": "index.ts",
+  "manifest": {
+    "endpoints": [
+      {
+        "path": "/health",
+        "method": "GET",
+        "handler": "health"
+      }
+    ]
+  }
+}

package/src/manifest/userApi/v1/integration-fixtures/valid-full.manifest.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://unpkg.com/@squiz/dx-json-schema-lib@latest/lib/manifest/userApiManifest/UserApiManifestV1.json",
+  "name": "integration-sample-api",
+  "displayName": "Integration sample API",
+  "description": "Fixture used only by filesystem-backed integration tests",
+  "filesDir": "src",
+  "entry": "index.ts",
+  "manifest": {
+    "endpoints": [
+      {
+        "path": "/integration/hello",
+        "method": "GET",
+        "handler": "index.helloWorld"
+      },
+      {
+        "path": "/integration/items",
+        "method": "POST",
+        "handler": "handlers.createItem"
+      }
+    ]
+  }
+}

package/src/manifest/userApi/v1/integration-fixtures/valid-resolved-slash-path.manifest.json

@@ -0,0 +1,14 @@
+{
+  "endpoints": [
+    {
+      "path": "/",
+      "method": "GET",
+      "handler": "root"
+    },
+    {
+      "path": "/integration/items",
+      "method": "POST",
+      "handler": "handlers.createItem"
+    }
+  ]
+}

package/src/manifest/userApi/v1/integration-fixtures/valid-resolved.manifest.json

@@ -0,0 +1,14 @@
+{
+  "endpoints": [
+    {
+      "path": "/integration/hello",
+      "method": "GET",
+      "handler": "index.helloWorld"
+    },
+    {
+      "path": "/integration/items",
+      "method": "POST",
+      "handler": "handlers.createItem"
+    }
+  ]
+}