@tileflow/vite 0.1.0-alpha.2 → 0.1.0-alpha.20

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -3,13 +3,55 @@
 Vite plugin for local Tileflow style development and static build artifacts.
 
 ```ts
-import react from "@vitejs/plugin-react";
-import { tileflow } from "@tileflow/vite";
-import { defineConfig } from "vite";
+import react from '@vitejs/plugin-react';
+import {defineConfig} from 'vite';
+import {tileflow} from '@tileflow/vite';
 
 export default defineConfig({
   plugins: [react(), tileflow()],
 });
 ```
 
+Omitting a component's `manifestUrl` is valid only when the public URL is exactly
+`/tileflow/manifest.json`. With a Vite or Tileflow base, pass the resulting public URL explicitly;
+the browser runtime deliberately does not guess bundler configuration:
+
+```ts
+export default defineConfig({
+  base: '/app/',
+  plugins: [react(), tileflow({base: '/maps'})],
+});
+
+// React; Vue and Svelte use the same source value.
+const source = {
+  kind: 'tileflow' as const,
+  map: 'main',
+  manifestUrl: '/app/maps/manifest.json',
+};
+```
+
+Development and production expose that same prefixed URL.
+
+Development snapshots local `hostedTileset()` archives for coherent preview requests. Production
+builds reject unresolved local PMTiles before emitting Tileflow assets; they never copy, hash, or
+deduplicate user datasets. Publish a managed tileset explicitly or provide an application-owned
+production source. Development Style URLs remain stable by logical tileset ID while the served
+snapshot changes by generation.
+
+The Vite process is the only application server needed. It watches config, transitive imports, and
+local icon/font files, serves the Tileflow manifest, styles, sprites, and prepared fonts, and reloads
+from the latest valid generation. To capture an application scene, keep `vite` running and point the
+short-lived headless command at that same loopback origin; do not start `tileflow dev`:
+
+```sh
+npm run dev
+TILEFLOW_APP_ORIGIN=http://127.0.0.1:5173 npx tileflow capture app-desktop
+```
+
+## Compatibility
+
+The supported peer window is Vite 5-8 on Node.js 22 or newer. CI installs the exact first release
+of each accepted Vite major with packed Tileflow tarballs, typechecks the plugin contract, and runs
+a production Vite build. Future majors remain excluded until the same smoke passes.
+
 Docs: https://tileflow.dev/docs

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 import { Plugin } from 'vite';
 
 type TileflowVitePluginOptions = {
+    apiBaseUrl?: string;
     base?: string;
     config?: string;
     emitBuildArtifacts?: boolean;
-    tileBaseUrl?: string;
+    overwriteHostedManifest?: boolean;
 };
 declare function tileflow(options?: TileflowVitePluginOptions): Plugin;
 

package/dist/index.js

@@ -1,11 +1,24 @@
 // src/index.ts
+import { resolve } from "path";
 import {
+  assertNoLocalTilesetsForProduction,
+  assertTileflowSelfHostedManifestTarget,
+  createTileflowArtifactSession,
   createTileflowBuildArtifacts,
-  createTileflowDevRequestHandler,
   defaultTileflowConfigPath,
-  normalizeTileflowBasePath
-} from "@tileflow/dev";
-import { resolve } from "path";
+  disposeTileflowBuildArtifacts,
+  getTileflowAssetBasePath,
+  getTileflowAssetFileName,
+  normalizeTileflowBasePath,
+  refreshTileflowArtifactSession,
+  resolveTileflowArtifactPublicUrls
+} from "@tileflow/dev/artifacts";
+import {
+  createTileflowDevRequestHandler,
+  createTileflowNodeRequest,
+  isTileflowRequestUrl,
+  writeTileflowNodeResponse
+} from "@tileflow/dev/server";
 function tileflow(options = {}) {
   const basePath = normalizeTileflowBasePath(options.base ?? "/tileflow");
   const configPath = options.config ?? defaultTileflowConfigPath;
@@ -18,31 +31,96 @@ function tileflow(options = {}) {
     configureServer(server) {
       const root = server.config.root;
       const configFile = resolve(root, configPath);
-      const handler = createTileflowDevRequestHandler({
-        basePath,
+      const devBasePaths = getViteDevBasePaths(server.config.base ?? "/", basePath);
+      const artifactBasePath = devBasePaths[devBasePaths.length - 1] ?? basePath;
+      const watchedInputPaths = /* @__PURE__ */ new Set();
+      const sessionPromise = createTileflowArtifactSession({
+        assetBaseUrl: artifactBasePath,
         config: configPath,
         cwd: root,
-        onError(error) {
-          const message = error instanceof Error ? error.message : "Unknown Tileflow error";
-          server.config.logger.error(`[tileflow] ${message}`);
-        },
-        tileBaseUrl: options.tileBaseUrl
+        styleBaseUrl: artifactBasePath,
+        apiBaseUrl: options.apiBaseUrl,
+        watch: false
       });
-      server.watcher.add(configFile);
-      server.watcher.on("change", (file) => {
-        if (file === configFile) {
-          server.ws.send({ type: "full-reload" });
+      const handlersPromise = sessionPromise.then((session) => {
+        session.subscribe((state) => {
+          if (state.status === "ready" && state.generation > 1) {
+            server.ws.send({ type: "full-reload" });
+          }
+        });
+        return new Map(
+          devBasePaths.map((devBasePath) => [
+            devBasePath,
+            createTileflowDevRequestHandler({
+              basePath: devBasePath,
+              config: configPath,
+              cwd: root,
+              onError(error) {
+                const message = error instanceof Error ? error.message : "Unknown Tileflow error";
+                server.config.logger.error(`[tileflow] ${message}`);
+              },
+              session,
+              apiBaseUrl: options.apiBaseUrl
+            })
+          ])
+        );
+      });
+      const refreshWatchedInputPaths = async () => {
+        try {
+          const session = await sessionPromise;
+          const watchPaths = session.getLastGoodArtifacts()?.watchPaths ?? [];
+          const nextWatchPaths = new Set(watchPaths);
+          const staleWatchPaths = [...watchedInputPaths].filter(
+            (watchPath) => !nextWatchPaths.has(watchPath)
+          );
+          if (staleWatchPaths.length > 0) {
+            await server.watcher.unwatch(staleWatchPaths);
+            for (const watchPath of staleWatchPaths) watchedInputPaths.delete(watchPath);
+          }
+          for (const watchPath of watchPaths) {
+            if (!watchedInputPaths.has(watchPath)) {
+              server.watcher.add(watchPath);
+              watchedInputPaths.add(watchPath);
+            }
+          }
+        } catch (error) {
+          const message = error instanceof Error ? error.message : "Unknown Tileflow error";
+          server.config.logger.warn(`[tileflow] Unable to watch input paths: ${message}`);
         }
+      };
+      const reloadIfTileflowInput = (file) => {
+        if (file !== configFile && !isWatchedInputPath(file, watchedInputPaths)) return;
+        void sessionPromise.then(async (session) => {
+          await refreshTileflowArtifactSession(session, {
+            inputPath: file,
+            reason: "vite watcher"
+          });
+          await refreshWatchedInputPaths();
+        });
+      };
+      server.watcher.add(configFile);
+      void refreshWatchedInputPaths();
+      server.watcher.on("add", reloadIfTileflowInput);
+      server.watcher.on("change", reloadIfTileflowInput);
+      server.watcher.on("unlink", reloadIfTileflowInput);
+      server.httpServer?.once("close", () => {
+        void sessionPromise.then((session) => session.close());
       });
       server.middlewares.use(async (request, response, next) => {
-        if (!isTileflowRequest(request.url, basePath)) {
+        const requestBasePath = devBasePaths.find(
+          (candidate) => isTileflowRequestUrl(request.url, candidate)
+        );
+        if (requestBasePath === void 0) {
           next();
           return;
         }
         try {
-          const tileflowRequest = toWebRequest(request);
+          const tileflowRequest = createTileflowNodeRequest(request);
+          const handler = (await handlersPromise).get(requestBasePath);
+          if (!handler)
+            throw new Error(`Missing Tileflow Vite handler for ${requestBasePath || "/"}`);
           const tileflowResponse = await handler(tileflowRequest);
-          await writeNodeResponse(response, tileflowResponse);
+          await writeTileflowNodeResponse(response, tileflowResponse);
         } catch (error) {
           next(error);
         }
@@ -56,72 +134,53 @@ function tileflow(options = {}) {
       if (!config) {
         return;
       }
+      const publicUrls = resolveTileflowArtifactPublicUrls(config.base, basePath);
       const artifacts = await createTileflowBuildArtifacts({
+        assetBaseUrl: publicUrls.assetBaseUrl,
         config: configPath,
         cwd: config.root,
-        styleBaseUrl: joinPublicUrl(config.base, basePath),
-        tileBaseUrl: options.tileBaseUrl
-      });
-      const assetBase = assetBasePath(basePath);
-      this.emitFile({
-        fileName: assetFileName(assetBase, "manifest.json"),
-        source: `${JSON.stringify(artifacts.manifest, null, 2)}
-`,
-        type: "asset"
+        styleBaseUrl: publicUrls.styleBaseUrl,
+        apiBaseUrl: options.apiBaseUrl,
+        target: "production"
       });
-      for (const [mapName, style] of Object.entries(artifacts.styles)) {
-        this.emitFile({
-          fileName: assetFileName(assetBase, `styles/${mapName}.json`),
-          source: `${JSON.stringify(style, null, 2)}
-`,
-          type: "asset"
-        });
+      try {
+        assertNoLocalTilesetsForProduction(artifacts);
+        const assetBase = getTileflowAssetBasePath(basePath);
+        await assertTileflowSelfHostedManifestTarget(
+          resolve(config.publicDir, assetBase, "manifest.json"),
+          { overwriteHostedManifest: options.overwriteHostedManifest }
+        );
+        for (const asset of artifacts.files) {
+          this.emitFile({
+            fileName: getTileflowAssetFileName(assetBase, asset.fileName),
+            source: asset.source,
+            type: "asset"
+          });
+        }
+      } finally {
+        await disposeTileflowBuildArtifacts(artifacts);
       }
     }
   };
 }
 var index_default = tileflow;
-function isTileflowRequest(url, basePath) {
-  const pathname = (url ?? "/").split("?")[0] ?? "/";
-  if (!basePath) {
-    return pathname === "/manifest.json" || pathname === "/style.json" || pathname === "/" || pathname.startsWith("/styles/");
-  }
-  return pathname === basePath || pathname.startsWith(`${basePath}/`);
-}
-function toWebRequest(request) {
-  const protocol = getHeader(request, "x-forwarded-proto") ?? "http";
-  const host = getHeader(request, "host") ?? "localhost";
-  return new Request(`${protocol}://${host}${request.url ?? "/"}`, {
-    method: request.method
-  });
-}
-function getHeader(request, name) {
-  const value = request.headers[name];
-  return Array.isArray(value) ? value[0] : value;
-}
-async function writeNodeResponse(response, tileflowResponse) {
-  response.statusCode = tileflowResponse.status;
-  tileflowResponse.headers.forEach((value, key) => {
-    response.setHeader(key, value);
-  });
-  response.end(Buffer.from(await tileflowResponse.arrayBuffer()));
-}
-function joinPublicUrl(viteBase, basePath) {
-  const trimmedBase = viteBase.replace(/\/+$/g, "");
-  const trimmedPath = basePath.replace(/^\/+|\/+$/g, "");
-  if (!trimmedPath) {
-    return trimmedBase || "";
-  }
-  if (!trimmedBase || trimmedBase === ".") {
-    return `/${trimmedPath}`;
+function isWatchedInputPath(file, watchedInputPaths) {
+  const normalizedFile = normalizePath(file);
+  for (const watchPath of watchedInputPaths) {
+    const normalizedWatchPath = normalizePath(watchPath);
+    if (normalizedFile === normalizedWatchPath || normalizedFile.startsWith(`${normalizedWatchPath}/`)) {
+      return true;
+    }
   }
-  return `${trimmedBase}/${trimmedPath}`;
+  return false;
 }
-function assetBasePath(basePath) {
-  return basePath.replace(/^\/+|\/+$/g, "");
+function normalizePath(value) {
+  return value.replace(/\\/g, "/");
 }
-function assetFileName(basePath, fileName) {
-  return basePath ? `${basePath}/${fileName}` : fileName;
+function getViteDevBasePaths(publicBase, basePath) {
+  const publicBaseUrl = resolveTileflowArtifactPublicUrls(publicBase, basePath).publicBaseUrl;
+  const publicPath = publicBaseUrl.startsWith("/") ? normalizeTileflowBasePath(publicBaseUrl) : basePath;
+  return [.../* @__PURE__ */ new Set([basePath, publicPath])];
 }
 export {
   index_default as default,

package/package.json

@@ -1,16 +1,21 @@
 {
   "name": "@tileflow/vite",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.20",
+  "license": "Apache-2.0",
   "description": "Vite plugin for Tileflow map style development and static artifacts.",
+  "engines": {
+    "node": ">=22"
+  },
   "type": "module",
+  "sideEffects": false,
   "homepage": "https://tileflow.dev",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/tileflow/tileflow.git",
+    "url": "git+https://github.com/tileflow/tileflow-sdk.git",
     "directory": "packages/vite"
   },
   "bugs": {
-    "url": "https://github.com/tileflow/tileflow/issues"
+    "url": "https://github.com/tileflow/tileflow-sdk/issues"
   },
   "keywords": [
     "tileflow",
@@ -22,7 +27,8 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "LICENSE"
   ],
   "exports": {
     ".": {
@@ -35,17 +41,20 @@
     "access": "public"
   },
   "dependencies": {
-    "@tileflow/dev": "0.1.0-alpha.2"
+    "@tileflow/dev": ">=0.1.0-alpha.22 <0.1.0-beta.0"
   },
   "peerDependencies": {
-    "vite": ">=5"
+    "vite": ">=5 <9"
   },
   "devDependencies": {
-    "vite": "^8.0.16"
+    "vite": "^8.0.16",
+    "@tileflow/maps": "0.1.0-alpha.2"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm --dts --clean --external vite --platform node",
+    "test": "tsx --test test/*.test.ts",
     "typecheck": "tsc -p tsconfig.json --noEmit",
-    "lint": "tsc -p tsconfig.json --noEmit"
+    "lint": "tsc -p tsconfig.json --noEmit",
+    "verify": "pnpm run typecheck && pnpm run test"
   }
 }