@jupytergis/schema 0.15.0 → 0.16.0-alpha.0

package/lib/_interface/project/layers/vectorTileLayer.d.ts

@@ -27,8 +27,6 @@ export interface IVectorTileLayer {
    * The state of the symbology panel options
    */
   symbologyState?: {
-    renderType: "Single Symbol" | "Graduated" | "Categorized" | "Canonical";
-    value?: string;
     method?: "color" | "radius";
     colorRamp?: string;
     nClasses?: string;
@@ -49,5 +47,571 @@ export interface IVectorTileLayer {
      * Whether the stroke color follows the fill color expression
      */
     strokeFollowsFill?: boolean;
+    /**
+     * Legacy top-level encoding rules (backward compatibility). New files should use layers.
+     */
+    rules?: {
+      /**
+       * Stable UUID.
+       */
+      id: string;
+      /**
+       * Input field name(s). Absent for constant rules.
+       */
+      fields?: string[];
+      /**
+       * (scale, channels) pairs sharing these input fields.
+       */
+      mappings: [
+        {
+          scale:
+            | {
+                scheme: "colorRamp";
+                params: {
+                  name: string;
+                  domain?: [number, number];
+                  nShades: number;
+                  mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                  reverse: boolean;
+                  /**
+                   * [R 0-255, G 0-255, B 0-255, A 0-1]
+                   */
+                  fallback: [number, number, number, number];
+                  colorStops?: {
+                    stop: number;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    color: [number, number, number, number];
+                  }[];
+                };
+              }
+            | {
+                scheme: "categorical";
+                params: {
+                  colorRamp: string;
+                  nShades?: number;
+                  reverse?: boolean;
+                  /**
+                   * [R 0-255, G 0-255, B 0-255, A 0-1]
+                   */
+                  fallback: [number, number, number, number];
+                  colorStops?: {
+                    stop: string | number;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    color: [number, number, number, number];
+                  }[];
+                };
+              }
+            | {
+                scheme: "scalar";
+                params: {
+                  domain: [number, number];
+                  range: [number, number];
+                  mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                  nStops: number;
+                  fallback: number;
+                  scalarStops?: {
+                    stop: number;
+                    output: number;
+                  }[];
+                };
+              }
+            | {
+                scheme: "constant_rgba";
+                params: {
+                  /**
+                   * [R 0-255, G 0-255, B 0-255, A 0-1]
+                   */
+                  value: [number, number, number, number];
+                };
+              }
+            | {
+                scheme: "constant_num";
+                params: {
+                  value: number;
+                };
+              }
+            | {
+                scheme: "identity";
+              }
+            | {
+                scheme: "expression";
+                params: {
+                  expr: string;
+                  fallback: number | [number, number, number, number];
+                };
+              };
+          /**
+           * Target output channel names.
+           */
+          channels: [
+            (
+              | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+              | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+              | ("fill-alpha" | "pixel-alpha")
+              | "pixel-rgb"
+              | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+            ),
+            ...(
+              | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+              | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+              | ("fill-alpha" | "pixel-alpha")
+              | "pixel-rgb"
+              | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+            )[]
+          ];
+        },
+        ...{
+          scale:
+            | {
+                scheme: "colorRamp";
+                params: {
+                  name: string;
+                  domain?: [number, number];
+                  nShades: number;
+                  mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                  reverse: boolean;
+                  /**
+                   * [R 0-255, G 0-255, B 0-255, A 0-1]
+                   */
+                  fallback: [number, number, number, number];
+                  colorStops?: {
+                    stop: number;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    color: [number, number, number, number];
+                  }[];
+                };
+              }
+            | {
+                scheme: "categorical";
+                params: {
+                  colorRamp: string;
+                  nShades?: number;
+                  reverse?: boolean;
+                  /**
+                   * [R 0-255, G 0-255, B 0-255, A 0-1]
+                   */
+                  fallback: [number, number, number, number];
+                  colorStops?: {
+                    stop: string | number;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    color: [number, number, number, number];
+                  }[];
+                };
+              }
+            | {
+                scheme: "scalar";
+                params: {
+                  domain: [number, number];
+                  range: [number, number];
+                  mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                  nStops: number;
+                  fallback: number;
+                  scalarStops?: {
+                    stop: number;
+                    output: number;
+                  }[];
+                };
+              }
+            | {
+                scheme: "constant_rgba";
+                params: {
+                  /**
+                   * [R 0-255, G 0-255, B 0-255, A 0-1]
+                   */
+                  value: [number, number, number, number];
+                };
+              }
+            | {
+                scheme: "constant_num";
+                params: {
+                  value: number;
+                };
+              }
+            | {
+                scheme: "identity";
+              }
+            | {
+                scheme: "expression";
+                params: {
+                  expr: string;
+                  fallback: number | [number, number, number, number];
+                };
+              };
+          /**
+           * Target output channel names.
+           */
+          channels: [
+            (
+              | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+              | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+              | ("fill-alpha" | "pixel-alpha")
+              | "pixel-rgb"
+              | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+            ),
+            ...(
+              | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+              | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+              | ("fill-alpha" | "pixel-alpha")
+              | "pixel-rgb"
+              | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+            )[]
+          ];
+        }[]
+      ];
+      /**
+       * Guard predicates for this rule.
+       */
+      when?: (
+        | {
+            type: "geometryType";
+            value: "Point" | "LineString" | "Polygon";
+          }
+        | {
+            type: "hasField";
+            field: string;
+          }
+        | {
+            type: "fieldEquals";
+            field: string;
+            value: string | number;
+          }
+        | {
+            type: "fieldCompare";
+            field: string;
+            op: ">" | "<" | ">=" | "<=" | "!=";
+            value: number;
+          }
+        | {
+            type: "between";
+            field: string;
+            min: number;
+            max: number;
+          }
+      )[];
+      /**
+       * Logical combinator for when predicates. Defaults to 'all'.
+       */
+      whenOp?: "all" | "any";
+    }[];
+    /**
+     * Grammar rendering layers. Each layer is an independent rendering pipeline with optional preprocess transforms and encoding rules.
+     */
+    layers?: {
+      /**
+       * Stable UUID.
+       */
+      id: string;
+      /**
+       * Render-side transforms (KDE, cluster) applied before encoding rules.
+       */
+      preprocess?: (
+        | {
+            type: "kde";
+            radius: number;
+            blur: number;
+            weightField?: string;
+          }
+        | {
+            type: "cluster";
+            radius: number;
+          }
+      )[];
+      /**
+       * Encoding rules compiled into a flat-style expression for this layer.
+       */
+      rules: {
+        /**
+         * Stable UUID.
+         */
+        id: string;
+        /**
+         * Input field name(s). Absent for constant rules.
+         */
+        fields?: string[];
+        /**
+         * (scale, channels) pairs sharing these input fields.
+         */
+        mappings: [
+          {
+            scale:
+              | {
+                  scheme: "colorRamp";
+                  params: {
+                    name: string;
+                    domain?: [number, number];
+                    nShades: number;
+                    mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                    reverse: boolean;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    fallback: [number, number, number, number];
+                    colorStops?: {
+                      stop: number;
+                      /**
+                       * [R 0-255, G 0-255, B 0-255, A 0-1]
+                       */
+                      color: [number, number, number, number];
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "categorical";
+                  params: {
+                    colorRamp: string;
+                    nShades?: number;
+                    reverse?: boolean;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    fallback: [number, number, number, number];
+                    colorStops?: {
+                      stop: string | number;
+                      /**
+                       * [R 0-255, G 0-255, B 0-255, A 0-1]
+                       */
+                      color: [number, number, number, number];
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "scalar";
+                  params: {
+                    domain: [number, number];
+                    range: [number, number];
+                    mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                    nStops: number;
+                    fallback: number;
+                    scalarStops?: {
+                      stop: number;
+                      output: number;
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "constant_rgba";
+                  params: {
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    value: [number, number, number, number];
+                  };
+                }
+              | {
+                  scheme: "constant_num";
+                  params: {
+                    value: number;
+                  };
+                }
+              | {
+                  scheme: "identity";
+                }
+              | {
+                  scheme: "expression";
+                  params: {
+                    expr: string;
+                    fallback: number | [number, number, number, number];
+                  };
+                };
+            /**
+             * Target output channel names.
+             */
+            channels: [
+              (
+                | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+                | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+                | ("fill-alpha" | "pixel-alpha")
+                | "pixel-rgb"
+                | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+              ),
+              ...(
+                | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+                | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+                | ("fill-alpha" | "pixel-alpha")
+                | "pixel-rgb"
+                | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+              )[]
+            ];
+          },
+          ...{
+            scale:
+              | {
+                  scheme: "colorRamp";
+                  params: {
+                    name: string;
+                    domain?: [number, number];
+                    nShades: number;
+                    mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                    reverse: boolean;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    fallback: [number, number, number, number];
+                    colorStops?: {
+                      stop: number;
+                      /**
+                       * [R 0-255, G 0-255, B 0-255, A 0-1]
+                       */
+                      color: [number, number, number, number];
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "categorical";
+                  params: {
+                    colorRamp: string;
+                    nShades?: number;
+                    reverse?: boolean;
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    fallback: [number, number, number, number];
+                    colorStops?: {
+                      stop: string | number;
+                      /**
+                       * [R 0-255, G 0-255, B 0-255, A 0-1]
+                       */
+                      color: [number, number, number, number];
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "scalar";
+                  params: {
+                    domain: [number, number];
+                    range: [number, number];
+                    mode: "equal interval" | "quantile" | "jenks" | "pretty" | "logarithmic";
+                    nStops: number;
+                    fallback: number;
+                    scalarStops?: {
+                      stop: number;
+                      output: number;
+                    }[];
+                  };
+                }
+              | {
+                  scheme: "constant_rgba";
+                  params: {
+                    /**
+                     * [R 0-255, G 0-255, B 0-255, A 0-1]
+                     */
+                    value: [number, number, number, number];
+                  };
+                }
+              | {
+                  scheme: "constant_num";
+                  params: {
+                    value: number;
+                  };
+                }
+              | {
+                  scheme: "identity";
+                }
+              | {
+                  scheme: "expression";
+                  params: {
+                    expr: string;
+                    fallback: number | [number, number, number, number];
+                  };
+                };
+            /**
+             * Target output channel names.
+             */
+            channels: [
+              (
+                | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+                | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+                | ("fill-alpha" | "pixel-alpha")
+                | "pixel-rgb"
+                | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+              ),
+              ...(
+                | ("fill-color" | "stroke-color" | "circle-fill-color" | "circle-stroke-color" | "pixel-color")
+                | ("fill-red" | "fill-green" | "fill-blue" | "pixel-red" | "pixel-green" | "pixel-blue")
+                | ("fill-alpha" | "pixel-alpha")
+                | "pixel-rgb"
+                | ("stroke-width" | "circle-radius" | "circle-stroke-width")
+              )[]
+            ];
+          }[]
+        ];
+        /**
+         * Guard predicates for this rule.
+         */
+        when?: (
+          | {
+              type: "geometryType";
+              value: "Point" | "LineString" | "Polygon";
+            }
+          | {
+              type: "hasField";
+              field: string;
+            }
+          | {
+              type: "fieldEquals";
+              field: string;
+              value: string | number;
+            }
+          | {
+              type: "fieldCompare";
+              field: string;
+              op: ">" | "<" | ">=" | "<=" | "!=";
+              value: number;
+            }
+          | {
+              type: "between";
+              field: string;
+              min: number;
+              max: number;
+            }
+        )[];
+        /**
+         * Logical combinator for when predicates. Defaults to 'all'.
+         */
+        whenOp?: "all" | "any";
+      }[];
+      /**
+       * Guard predicates applied to every rule in this layer.
+       */
+      when?: (
+        | {
+            type: "geometryType";
+            value: "Point" | "LineString" | "Polygon";
+          }
+        | {
+            type: "hasField";
+            field: string;
+          }
+        | {
+            type: "fieldEquals";
+            field: string;
+            value: string | number;
+          }
+        | {
+            type: "fieldCompare";
+            field: string;
+            op: ">" | "<" | ">=" | "<=" | "!=";
+            value: number;
+          }
+        | {
+            type: "between";
+            field: string;
+            min: number;
+            max: number;
+          }
+      )[];
+      /**
+       * Logical combinator for when predicates. Defaults to 'all'.
+       */
+      whenOp?: "all" | "any";
+    }[];
   };
 }

package/lib/_interface/project/sources/geoJsonSource.d.ts

@@ -28,6 +28,14 @@ export interface IGeoJSONSource {
    */
   path?: string | null;
   data?: GeoJSON;
+  /**
+   * Route requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream server when useProxy is true.
+   */
+  httpHeaders?: string;
 }
 export interface GeoJSONPoint {
   type: "Point";

package/lib/_interface/project/sources/geoPackageRasterSource.d.ts

@@ -0,0 +1,36 @@
+/* tslint: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.
+ */
+
+/**
+ * GeoPackageRasterSource
+ */
+export interface IGeoPackageRasterSource {
+  /**
+   * The path to the GeoPackage source
+   */
+  path: string;
+  /**
+   * The minimum zoom level for the raster source
+   */
+  minZoom?: number;
+  /**
+   * The maximum zoom level for the raster source
+   */
+  maxZoom?: number;
+  /**
+   * The names of the tables in the GeoPackage to use as a source (optional). If left empty, all tables will be used.
+   */
+  tables?: string;
+  /**
+   * The attribution for the GeoPackage source
+   */
+  attribution?: string;
+  /**
+   * Interpolate between grid cells when overzooming?
+   */
+  interpolate?: boolean;
+}

package/lib/_interface/project/sources/geoPackageVectorSource.d.ts

@@ -0,0 +1,28 @@
+/* tslint: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.
+ */
+
+/**
+ * GeoPackageVectorSource
+ */
+export interface IGeoPackageVectorSource {
+  /**
+   * The path to the GeoPackage source
+   */
+  path: string;
+  /**
+   * The attribution for the GeoPackage source.
+   */
+  attribution?: string;
+  /**
+   * The projection information for the GeoPackage data (optional).
+   */
+  projection?: string;
+  /**
+   * The names of the tables in the GeoPackage to use as a source (optional). If left empty, all tables will be used.
+   */
+  tables?: string;
+}

package/lib/_interface/project/sources/geoParquetSource.d.ts

@@ -21,4 +21,12 @@ export interface IGeoParquetSource {
    * The projection information for the GeoParquet data (optional).
    */
   projection?: string;
+  /**
+   * Route requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream server when useProxy is true.
+   */
+  httpHeaders?: string;
 }

package/lib/_interface/project/sources/geoTiffSource.d.ts

@@ -38,4 +38,12 @@ export interface IGeoTiffSource {
    * Interpolate between grid cells when overzooming?
    */
   interpolate?: boolean;
+  /**
+   * Route requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream server when useProxy is true.
+   */
+  httpHeaders?: string;
 }

package/lib/_interface/project/sources/imageSource.d.ts

@@ -21,4 +21,12 @@ export interface IImageSource {
    * Interpolate between grid cells when overzooming?
    */
   interpolate?: boolean;
+  /**
+   * Route requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream server when useProxy is true.
+   */
+  httpHeaders?: string;
 }