@unvt/charites 0.3.0 → 0.4.0

package/.eslintrc.js

@@ -6,8 +6,8 @@ module.exports = {
   },
   extends: [
     'plugin:@typescript-eslint/recommended',
-    'prettier/@typescript-eslint',
     'plugin:prettier/recommended',
+    'prettier',
   ],
   rules: {
     '@typescript-eslint/explicit-module-boundary-types': 0,

package/.github/workflows/build-docs.yml

@@ -1,6 +1,6 @@
 name: Build and Deploy docs
 
-on: 
+on:
   push:
     branches:
       - main
@@ -21,9 +21,9 @@ jobs:
       TX_TOKEN: ${{ secrets.TX_TOKEN }}
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: Set up Python 3.9
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: 3.9
 
@@ -65,7 +65,7 @@ jobs:
         touch ./build/html/.nojekyll
 
     - name: Deploy 🚀
-      uses: JamesIves/github-pages-deploy-action@4.1.7
+      uses: JamesIves/github-pages-deploy-action@v4
       if: ${{ github.ref == 'refs/heads/main' }}
       with:
         branch: gh-pages # The branch the action should deploy to.

package/.github/workflows/build.yml

@@ -14,14 +14,15 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
     strategy:
       matrix:
         node-version: [14.x, 16.x, 18.x]
+        os: [ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm install
@@ -34,9 +35,9 @@ jobs:
       matrix:
         node-version: [18.x]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - name: Check and restore cache of playwright
@@ -61,9 +62,9 @@ jobs:
     needs: build
     if: startsWith(github.ref, 'refs/tags/v')
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       # Setup .npmrc file to publish to npm
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v3
         with:
           tag_name: 'v%s'
           node-version: '14.x'

package/dist/cli/build.js

@@ -40,7 +40,7 @@ program
         try {
             console.log('Start watching...');
             await new Promise((resolve) => {
-                const watcher = build_1.buildWatch(source, destination, options);
+                const watcher = (0, build_1.buildWatch)(source, destination, options);
                 process.on('SIGINT', () => {
                     watcher.close();
                     resolve(undefined);
@@ -48,15 +48,15 @@ program
             });
         }
         catch (e) {
-            error_1.error(e);
+            (0, error_1.error)(e);
         }
     }
     else {
         try {
-            await build_1.build(source, destination, options);
+            await (0, build_1.build)(source, destination, options);
         }
         catch (e) {
-            error_1.error(e);
+            (0, error_1.error)(e);
         }
     }
 });

package/dist/cli/convert.js

@@ -10,10 +10,10 @@ program
     .description('convert the style JSON to YAML')
     .action((source, destination) => {
     try {
-        convert_1.convert(source, destination);
+        (0, convert_1.convert)(source, destination);
     }
     catch (e) {
-        error_1.error(e);
+        (0, error_1.error)(e);
     }
 });
 exports.default = program;

package/dist/cli/init.js

@@ -7,7 +7,7 @@ const program = new commander_1.Command();
 program
     .name('init')
     .arguments('<file>')
-    .description('initialize a style JSON')
+    .description('initialize a style YAML')
     .option('-t, --tilejson-urls <tilejson_urls>', 'an URL for TileJSON. It will create empty layers from vector_layers property of TileJSON. Please use comma (,) in case multiple TileJSONs require.')
     .option('-m, --metadatajson-urls <metadatajson_urls>', 'an URL for metadata.json. It will create empty layers from vector_layers property of metadata.json. Please use comma (,) in case multiple metadata.json require.')
     .option('-c, --composite-layers', 'If it is true, a single YAML will be generated with multiple layers. Default is false.')
@@ -17,10 +17,10 @@ program
     options.metadatajsonUrls = initOptions.metadatajsonUrls;
     options.compositeLayers = initOptions.compositeLayers;
     try {
-        await init_1.init(file, options);
+        await (0, init_1.init)(file, options);
     }
     catch (e) {
-        error_1.error(e);
+        (0, error_1.error)(e);
     }
 });
 exports.default = program;

package/dist/cli/serve.js

@@ -15,20 +15,24 @@ program
     .description('serve your map locally')
     .option('--provider [provider]', 'your map service. e.g. `mapbox`, `geolonia`')
     .option('--mapbox-access-token [mapboxAccessToken]', 'Your Mapbox Access Token (required if using the `mapbox` provider)')
+    .option('-i, --sprite-input [<icon input directory>]', 'directory path of icon source to build icons. The default <icon source> is `icons/`')
     .option('--port [port]', 'Specify custom port')
-    .action((source, serveOptions) => {
+    .option('--no-open', "Don't open the preview in the default browser")
+    .action(async (source, serveOptions) => {
     const options = program.opts();
     options.provider = serveOptions.provider;
     options.mapboxAccessToken = serveOptions.mapboxAccessToken;
     options.port = serveOptions.port;
+    options.spriteInput = serveOptions.spriteInput;
+    options.open = serveOptions.open;
     if (!fs_1.default.existsSync(defaultValues_1.defaultSettings.configFile)) {
         fs_1.default.writeFileSync(defaultValues_1.defaultSettings.configFile, `provider: ${options.provider || 'default'}`);
     }
     try {
-        serve_1.serve(source, program.opts());
+        await (0, serve_1.serve)(source, program.opts());
     }
     catch (e) {
-        error_1.error(e);
+        (0, error_1.error)(e);
     }
 });
 exports.default = program;

package/dist/commands/build.js

@@ -40,8 +40,8 @@ async function build(source, destination, options) {
     }
     let style = '';
     try {
-        const _style = yaml_parser_1.parser(sourcePath);
-        validate_style_1.validateStyle(_style, provider);
+        const _style = (0, yaml_parser_1.parser)(sourcePath);
+        (0, validate_style_1.validateStyle)(_style, provider);
         if (options.spriteUrl && 'sprite' in _style) {
             _style.sprite = options.spriteUrl;
         }
@@ -53,14 +53,14 @@ async function build(source, destination, options) {
             if (!fs_1.default.existsSync(options.spriteOutput)) {
                 throw `${options.spriteOutput}: No such directory. Please specify valid icon output directory. For more help run charites build --help`;
             }
-            const iconSlug = get_sprite_slug_1.getSpriteSlug(JSON.parse(style));
+            const iconSlug = (0, get_sprite_slug_1.getSpriteSlug)(JSON.parse(style));
             if (!iconSlug) {
                 throw `Invalid sprite url format.`;
             }
-            await build_sprite_1.buildSprite(options.spriteInput, options.spriteOutput, iconSlug);
+            await (0, build_sprite_1.buildSprite)(options.spriteInput, options.spriteOutput, iconSlug);
         }
         if (options.compactOutput) {
-            style = jsonminify_1.default(style);
+            style = (0, jsonminify_1.default)(style);
         }
     }
     catch (err) {
@@ -71,12 +71,7 @@ async function build(source, destination, options) {
             throw `${sourcePath}: Invalid YAML syntax`;
         }
     }
-    try {
-        fs_1.default.writeFileSync(destinationPath, style);
-    }
-    catch (err) {
-        throw `${destinationPath}: Permission denied`;
-    }
+    fs_1.default.writeFileSync(destinationPath, style);
 }
 exports.build = build;
 function buildWatch(source, destination, options) {
@@ -85,7 +80,7 @@ function buildWatch(source, destination, options) {
         sourcePath = source;
     }
     console.log(path_1.default.dirname(sourcePath));
-    return node_watch_1.default(path_1.default.dirname(sourcePath), { recursive: true, filter: /\.yml$/ }, (event, file) => {
+    return (0, node_watch_1.default)(path_1.default.dirname(sourcePath), { recursive: true, filter: /\.yml$/ }, (event, file) => {
         console.log(`${(event || '').toUpperCase()}: ${file}`);
         try {
             build(source, destination, options);

package/dist/commands/convert.js

@@ -42,12 +42,7 @@ function convert(source, destination) {
         rl.on('close', () => {
             const style = JSON.parse(lines.join(''));
             const destinationPath = getDestinationPath(destination);
-            try {
-                yaml_writer_1.writeYaml(destinationPath, style, false);
-            }
-            catch (err) {
-                throw `${destinationPath}: Permission denied`;
-            }
+            (0, yaml_writer_1.writeYaml)(destinationPath, style, false);
         });
     }
     else {
@@ -61,12 +56,7 @@ function convert(source, destination) {
         }
         style = JSON.parse(fs_1.default.readFileSync(sourcePath, 'utf-8'));
         const destinationPath = getDestinationPath(destination, sourcePath);
-        try {
-            yaml_writer_1.writeYaml(destinationPath, style, false);
-        }
-        catch (err) {
-            throw `${destinationPath}: Permission denied`;
-        }
+        (0, yaml_writer_1.writeYaml)(destinationPath, style, false);
     }
 }
 exports.convert = convert;

package/dist/commands/init.js

@@ -21,6 +21,6 @@ async function init(file, options) {
         const metadataJSONImporter = new tileinfo_importer_1.MetadataJSONImporter(options.metadatajsonUrls);
         styleTemplate = await metadataJSONImporter.import(styleTemplate);
     }
-    yaml_writer_1.writeYaml(file, styleTemplate, options.compositeLayers);
+    (0, yaml_writer_1.writeYaml)(file, styleTemplate, options.compositeLayers);
 }
 exports.init = init;

package/dist/commands/serve.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.serve = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
 const http_1 = __importDefault(require("http"));
 const open_1 = __importDefault(require("open"));
 const ws_1 = require("ws");
@@ -13,7 +14,8 @@ const node_watch_1 = __importDefault(require("node-watch"));
 const yaml_parser_1 = require("../lib/yaml-parser");
 const validate_style_1 = require("../lib/validate-style");
 const defaultValues_1 = require("../lib/defaultValues");
-function serve(source, options) {
+const build_sprite_1 = require("../lib/build-sprite");
+async function serve(source, options) {
     let port = process.env.PORT || 8080;
     if (options.port) {
         port = Number(options.port);
@@ -34,10 +36,38 @@ function serve(source, options) {
     if (provider === 'mapbox' && !mapboxAccessToken) {
         throw `Provider is mapbox, but the Mapbox Access Token is not set. Please provide it using --mapbox-access-token, or set it in \`~/.charites/config.yml\` (see the Global configuration section of the documentation for more information)`;
     }
-    const server = http_1.default.createServer((req, res) => {
+    let spriteOut = undefined;
+    let spriteRefresher = undefined;
+    if (options.spriteInput) {
+        spriteOut = await fs_1.default.promises.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'charites-'));
+        spriteRefresher = async () => {
+            if (typeof options.spriteInput === 'undefined' ||
+                typeof spriteOut === 'undefined') {
+                return;
+            }
+            await (0, build_sprite_1.buildSprite)(options.spriteInput, spriteOut, 'sprite');
+        };
+        await spriteRefresher();
+    }
+    const server = http_1.default.createServer(async (req, res) => {
         const url = (req.url || '').replace(/\?.*/, '');
         const defaultProviderDir = path_1.default.join(defaultValues_1.defaultValues.providerDir, 'default');
         const providerDir = path_1.default.join(defaultValues_1.defaultValues.providerDir, provider);
+        if (typeof spriteOut !== 'undefined' &&
+            url.match(/^\/sprite(@2x)?\.(json|png)/)) {
+            res.statusCode = 200;
+            if (url.endsWith('.json')) {
+                res.setHeader('Content-Type', 'application/json; charset=UTF-8');
+            }
+            else {
+                res.setHeader('Content-Type', 'image/png');
+            }
+            res.setHeader('Cache-Control', 'no-store');
+            const filename = path_1.default.basename(url);
+            const fsStream = fs_1.default.createReadStream(path_1.default.join(spriteOut, filename));
+            fsStream.pipe(res);
+            return;
+        }
         switch (url) {
             case '/':
                 res.statusCode = 200;
@@ -48,14 +78,18 @@ function serve(source, options) {
             case '/style.json':
                 let style;
                 try {
-                    style = yaml_parser_1.parser(sourcePath);
-                    validate_style_1.validateStyle(style, provider);
+                    style = (0, yaml_parser_1.parser)(sourcePath);
+                    if (typeof spriteOut !== 'undefined') {
+                        style.sprite = `http://${req.headers.host || `localhost:${port}`}/sprite`;
+                    }
+                    (0, validate_style_1.validateStyle)(style, provider);
                 }
                 catch (error) {
                     console.log(error);
                 }
                 res.statusCode = 200;
                 res.setHeader('Content-Type', 'application/json; charset=UTF-8');
+                res.setHeader('Cache-Control', 'no-store');
                 res.end(JSON.stringify(style));
                 break;
             case '/app.css':
@@ -96,26 +130,45 @@ function serve(source, options) {
         console.log(`Provider: ${provider}`);
         console.log(`Loading your style: ${sourcePath}`);
         console.log(`Your map is running on http://localhost:${port}/\n`);
-        open_1.default(`http://localhost:${port}`);
+        if (options.open) {
+            (0, open_1.default)(`http://localhost:${port}`);
+        }
     });
     const wss = new ws_1.WebSocketServer({ server });
     wss.on('connection', (ws) => {
-        node_watch_1.default(path_1.default.dirname(sourcePath), { recursive: true, filter: /\.yml$/ }, (event, file) => {
+        const watcher = (0, node_watch_1.default)(path_1.default.dirname(sourcePath), { recursive: true, filter: /\.yml$|\.svg$/i }, (event, file) => {
             console.log(`${(event || '').toUpperCase()}: ${file}`);
             try {
-                const style = yaml_parser_1.parser(sourcePath);
-                try {
-                    validate_style_1.validateStyle(style, provider);
+                if (file === null || file === void 0 ? void 0 : file.toLowerCase().endsWith('.yml')) {
+                    ws.send(JSON.stringify({
+                        event: 'styleUpdate',
+                    }));
                 }
-                catch (error) {
-                    console.log(error);
+                else if ((file === null || file === void 0 ? void 0 : file.toLowerCase().endsWith('.svg')) &&
+                    typeof spriteRefresher !== 'undefined') {
+                    spriteRefresher().then(() => {
+                        ws.send(JSON.stringify({
+                            event: 'spriteUpdate',
+                        }));
+                    });
                 }
-                ws.send(JSON.stringify(style));
             }
             catch (e) {
                 // Nothing to do
             }
         });
+        ws.on('close', () => {
+            watcher.close();
+        });
+    });
+    process.on('SIGINT', () => {
+        console.log('Cleaning up...');
+        server.close();
+        if (typeof spriteOut !== 'undefined') {
+            fs_1.default.rmSync(spriteOut, { recursive: true });
+            spriteOut = undefined;
+        }
+        process.exit(0);
     });
     return server;
 }

package/dist/lib/build-sprite.js

@@ -1,17 +1,15 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildSprite = void 0;
 const sprite_one_1 = require("@unvt/sprite-one");
-const path = require('path');
+const path_1 = __importDefault(require("path"));
 async function buildSprite(svgPath, publicPath, iconSlug) {
     const pxRatios = [1, 2];
-    const outPath = path.join(publicPath, iconSlug);
-    try {
-        await sprite_one_1.generateSprite(outPath, [svgPath], pxRatios);
-    }
-    catch (error) {
-        throw error;
-    }
+    const outPath = path_1.default.join(publicPath, iconSlug);
+    await (0, sprite_one_1.generateSprite)(outPath, [svgPath], pxRatios);
     return;
 }
 exports.buildSprite = buildSprite;

package/dist/lib/error.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.error = void 0;
-exports.error = (e) => {
+const error = (e) => {
     if (e instanceof Error) {
         console.error(e.message);
     }
@@ -10,3 +10,4 @@ exports.error = (e) => {
     }
     process.exit(1);
 };
+exports.error = error;

package/dist/lib/tileinfo-importer/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TileJSONImporter = exports.MetadataJSONImporter = void 0;
 var metadata_importer_1 = require("./metadata-importer");
 Object.defineProperty(exports, "MetadataJSONImporter", { enumerable: true, get: function () { return metadata_importer_1.MetadataJSONImporter; } });
 var tilejson_importer_1 = require("./tilejson-importer");

package/dist/lib/yaml-writer.js

@@ -7,7 +7,7 @@ exports.writeYaml = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
-exports.writeYaml = (destinationPath, style, composite = false) => {
+const writeYaml = (destinationPath, style, composite = false) => {
     if (composite === true) {
         writeCompositedYaml(destinationPath, style);
     }
@@ -15,6 +15,7 @@ exports.writeYaml = (destinationPath, style, composite = false) => {
         writeDecompositedYaml(destinationPath, style);
     }
 };
+exports.writeYaml = writeYaml;
 const writeCompositedYaml = (destinationPath, style) => {
     const styleYAML = js_yaml_1.default.dump(style);
     let stylePath = path_1.default.resolve(process.cwd(), destinationPath);
@@ -22,13 +23,22 @@ const writeCompositedYaml = (destinationPath, style) => {
     if (destinationPath.match(/^\//)) {
         stylePath = destinationPath;
     }
-    try {
-        fs_1.default.writeFileSync(stylePath, styleYAML);
-    }
-    catch (err) {
-        throw `${stylePath}: Permission denied`;
-    }
+    fs_1.default.writeFileSync(stylePath, styleYAML);
 };
+class IncFileTag {
+    constructor(fileName) {
+        // We use path.posix.join to make sure the path uses / path separators, even when run on Windows.
+        this.value = path_1.default.posix.join('layers', fileName);
+    }
+}
+const INC_PATH_TYPE = new js_yaml_1.default.Type('tag:yaml.org,2002:inc/file', {
+    kind: 'scalar',
+    resolve: (data) => data,
+    construct: (data) => new IncFileTag(data),
+    instanceOf: IncFileTag,
+    represent: (tag) => tag.value,
+});
+const INC_PATH_OUTPUT_SCHEMA = js_yaml_1.default.DEFAULT_SCHEMA.extend([INC_PATH_TYPE]);
 const writeDecompositedYaml = (destinationPath, style) => {
     const layers = [];
     for (let i = 0; i < style.layers.length; i++) {
@@ -39,13 +49,12 @@ const writeDecompositedYaml = (destinationPath, style) => {
         const filePath = path_1.default.join(layersDirName, fileName);
         fs_1.default.mkdirSync(path_1.default.dirname(filePath), { recursive: true });
         fs_1.default.writeFileSync(filePath, layerYml);
-        // ts-ignore is required here because !!inc/file string is not compatible with the Layer object type.
-        // We use path.posix.join to make sure the path uses / path separators, even when run on Windows.
+        // ts-ignore is required here because the !!inc/file object is not compatible with the Layer object type.
         // @ts-ignore
-        layers.push(`!!inc/file ${path_1.default.posix.join('layers', fileName)}`);
+        layers.push(new IncFileTag(fileName));
     }
     style.layers = layers;
-    fs_1.default.writeFileSync(destinationPath, js_yaml_1.default.dump(style).replace(/'\!\!inc\/file layers\/.+\.yml'/g, function (match) {
-        return match.replace(/'/g, '');
+    fs_1.default.writeFileSync(destinationPath, js_yaml_1.default.dump(style, {
+        schema: INC_PATH_OUTPUT_SCHEMA,
     }));
 };

package/dist/types/index.js

@@ -1,13 +1,17 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./tilejson"), exports);