@pipedream/mapbox 0.0.2 → 0.1.0

package/LICENSE

@@ -1,7 +1,41 @@
-Copyright 2020 Pipedream, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Pipedream Source Available License Version 1.0
+ 
+This Pipedream Source Available License Agreement Version 1.0 (this “Agreement”) sets forth the terms on which Pipedream, Inc., a Delaware corporation (“Pipedream”) makes available certain software (the “Software”). By installing, downloading, accessing, using or distributing the Software, you agree to the terms of this Agreement. If you do not agree to such terms, you must not use the Software. If you are receiving the Software on behalf of a legal entity, you represent and warrant that you have the actual authority to agree to the terms and conditions of this Agreement on behalf of such entity. “Licensee” means you, an individual, or the entity on whose behalf you are receiving the Software.
+ 
+LICENSE GRANT AND CONDITIONS.
+ 
+1.1  License. Subject to the terms and conditions of this Agreement, Pipedream hereby grants to Licensee a non-exclusive, royalty-free, worldwide, non-transferable, non-sublicenseable license during the term of this Agreement to use, prepare modifications and derivative works, distribute (including without limitation in source code or object code form) and reproduce copies of the Software (the “License”). Licensee is not granted the right to, and Licensee shall not, exercise the License for an Excluded Purpose. For purposes of this Agreement, “Excluded Purpose” means any commercial use of the software including, but not limited to, making available any software-as-a-service, platform-as-a-service, infrastructure-as-a-service or other online service that competes with the Software or any other Pipedream products or services.
+ 
+1.2  Conditions. In consideration of the License, Licensee’s distribution of the Software is subject to the following conditions:
+ 
+a. Licensee must cause any Software modified by Licensee to carry prominent notices stating that Licensee modified the Software.
+ 
+b. On each Software copy, Licensee shall reproduce and not remove or alter all Pipedream or third party copyright or other proprietary notices contained in the Software, and Licensee must provide this with each copy: “This software is made available by Pipedream, Inc., under the terms of the Pipedream Source Available License, Version 1.0 located at https://github.com/PipedreamHQ/pipedream/blob/master/LICENSE. By installing, downloading, accessing, using or distributing the Software, you agree to the terms of such License Agreement.”
+ 
+1.3  Modifications. Licensee may add its own copyright notices to modifications made by Licensee and may provide additional or different license terms and conditions for use, reproduction, or distribution of Licensee’s modifications. While redistributing the Software or modifications thereof, Licensee may choose to offer, for a fee or free of charge, support, warranty, indemnity, or other obligations. Licensee, and not Pipedream, will be responsible for any such obligations.
+ 
+1.4  No Sublicensing. The License does not include the right to sublicense the Software; provided, however, that any recipient to which Licensee provides the Software may exercise the License so long as such recipient agrees to the terms and conditions of this Agreement.
+ 
+TERM AND TERMINATION.
+ 
+This Agreement will continue unless and until earlier terminated as set forth herein. If Licensee breaches any of its conditions or obligations under this Agreement, this Agreement will terminate automatically and the License will terminate automatically and permanently.
+ 
+INTELLECTUAL PROPERTY.
+ 
+As between the parties, Pipedream retains all right, title, and interest in the Software, and all intellectual property rights therein. Pipedream hereby reserves all rights not expressly granted to Licensee in this Agreement. Pipedream reserves all rights in its trademarks and service marks, and no licenses thereto are granted by this Agreement.
+ 
+DISCLAIMER.
+ 
+PIPEDREAM HEREBY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE SOFTWARE.
+ 
+LIMITATION OF LIABILITY.
+ 
+PIPEDREAM WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO, LOST PROFITS OR ANY CONSEQUENTIAL, SPECIAL, INCIDENTAL, INDIRECT, OR DIRECT DAMAGES, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, ARISING OUT OF THIS AGREEMENT. THE FOREGOING SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW.
+ 
+GENERAL.
+ 
+6.1  Governing Law. This Agreement will be governed by and interpreted in accordance with the laws of the state of California, without reference to its conflict of laws principles. If Licensee is located outside of the United States, any dispute, controversy or claim arising out of or relating to this Agreement will be referred to and finally determined by arbitration in accordance with the JAMS International Arbitration Rules. The tribunal will consist of one arbitrator. Judgment upon the award rendered by the arbitrator may be entered in any court having jurisdiction thereof. All disputes including arbitrations shall take place in Santa Clara County, California. The language to be used in any such proceedings shall be English.
+ 
+6.2.  Assignment. Licensee is not authorized to assign its rights under this Agreement to any third party. Pipedream may freely assign its rights under this Agreement to any third party.
+ 
+6.3.  Other. This Agreement is the entire agreement between the parties regarding the subject matter hereof. No amendment or modification of this Agreement will be valid or binding upon the parties unless made in writing and signed by the duly authorized representatives of both parties. In the event that any provision, including without limitation any condition, of this Agreement is held to be unenforceable, this Agreement and all licenses and rights granted hereunder will immediately terminate. Waiver by Pipedream of a breach of any provision of this Agreement or the failure by Pipedream to exercise any right hereunder will not be construed as a waiver of any subsequent breach of that right or as a waiver of any other right.

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Mapbox API offers a suite of tools for developers to integrate location-based services into their applications. With Pipedream, you can leverage Mapbox's capabilities to create complex automations and workflows, like real-time mapping, geocoding, and route optimization. Whether you're managing delivery routes, analyzing spatial data, or personalizing user experiences based on location, Mapbox provides the geographical intelligence that, when combined with Pipedream's serverless platform, can turn these ideas into efficient, automated processes.
+
+# Example Use Cases
+
+- **Customer Order Tracking**: When a customer places an order, automate the process of sending them real-time updates on the delivery driver's location. Use Mapbox to track the driver and Pipedream's workflow to trigger emails or SMS notifications via Twilio to the customer at key points along the route.
+
+- **Localized Content Delivery**: Tailor the user experience by serving location-specific content. When a user visits your site, use their IP address to determine their location with Mapbox and serve up local news, weather, or personalized recommendations. This workflow could include a connection to a CMS like WordPress to pull the relevant content.
+
+- **Efficient Dispatch System**: Optimize dispatching for services like taxi or delivery by using Mapbox's routing capabilities. When a service request comes in, Pipedream can use Mapbox to calculate the nearest available driver and the quickest route to the customer, then communicate the dispatch details through Slack or another messaging service to coordinate the pickup.

package/actions/create-tileset/create-tileset.mjs

@@ -0,0 +1,99 @@
+import mapbox from "../../mapbox.app.mjs";
+import fs from "fs";
+import FormData from "form-data";
+
+export default {
+  key: "mapbox-create-tileset",
+  name: "Create Tileset",
+  description: "Uploads and creates a new tileset from a data source. [See the documentation](https://docs.mapbox.com/api/maps/mapbox-tiling-service/)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    mapbox,
+    username: {
+      type: "string",
+      label: "Username",
+      description: "The Mapbox username of the account for which to create a tileset source",
+    },
+    tilesetName: {
+      type: "string",
+      label: "Tileset Name",
+      description: "A unique name for the tileset source to be created. Limited to 32 characters. The only allowed special characters are `-` (hyphen) and `_` (underscore)",
+    },
+    filePath: {
+      type: "string",
+      label: "File Path",
+      description: "The path to a tileset source file in the `/tmp` directory. [See the documentation on working with files](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
+    },
+    recipe: {
+      type: "object",
+      label: "Recipe",
+      description: "A recipe that describes how the GeoJSON data you uploaded should be transformed into tiles. A tileset source is raw geographic data formatted as [line-delimited GeoJSON](https://en.wikipedia.org/wiki/JSON_streaming#Line-delimited_JSON), or a supported [raster file format](https://docs.mapbox.com/mapbox-tiling-service/raster/supported-file-formats/). For more information on how to create and format recipes, see the [Recipe reference](https://docs.mapbox.com/mapbox-tiling-service/reference/) and [Recipe examples](https://docs.mapbox.com/mapbox-tiling-service/examples/).",
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "A description of the tileset",
+      optional: true,
+    },
+    private: {
+      type: "boolean",
+      label: "Private",
+      description: "Describes whether the tileset must be used with an access token from your Mapbox account. Default is `true`.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const filePath = this.filePath.includes("tmp/")
+      ? this.filePath
+      : `/tmp/${this.filePath}`;
+
+    // Create Tileset Source
+    try {
+      const fileData = new FormData();
+      const content = fs.createReadStream(filePath);
+      fileData.append("file", content);
+
+      await this.mapbox.createTilesetSource({
+        $,
+        username: this.username,
+        id: this.tilesetName,
+        data: fileData,
+        headers: fileData.getHeaders(),
+      });
+    } catch (e) {
+      throw new Error(`Error uploading file: \`${filePath}\`. Error: ${e}`);
+    }
+
+    const recipe = typeof this.recipe === "string"
+      ? JSON.parse(this.recipe)
+      : this.recipe;
+
+    // Validate Recipe
+    const {
+      valid, errors,
+    } = await this.mapbox.validateRecipe({
+      $,
+      data: recipe,
+    });
+
+    if (!valid) {
+      throw new Error(`Error validating recipe: ${errors}`);
+    }
+
+    // Create Tileset
+    const response = await this.mapbox.createTileset({
+      $,
+      tilesetId: `${this.username}.${this.tilesetName}`,
+      data: {
+        recipe,
+        name: this.tilesetName,
+        description: this.description,
+        private: this.private,
+      },
+    });
+
+    $.export("$summary", `Created tileset ${this.tilesetName}`);
+    return response;
+  },
+};

package/actions/generate-directions/generate-directions.mjs

@@ -0,0 +1,60 @@
+import mapbox from "../../mapbox.app.mjs";
+
+export default {
+  key: "mapbox-generate-directions",
+  name: "Generate Directions",
+  description: "Generates directions between two or more locations using Mapbox API. [See the documentation](https://docs.mapbox.com/api/navigation/directions/).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    mapbox,
+    startCoordinate: {
+      type: "string",
+      label: "Start Coordinate",
+      description: "The starting point in the format `longitude,latitude`, E.g. `-85.244869,37.835819`",
+    },
+    endCoordinate: {
+      type: "string",
+      label: "End Coordinate",
+      description: "The ending point in the format `longitude,latitude`, E.g. `-85.244869,37.835819`",
+    },
+    transportationMode: {
+      propDefinition: [
+        mapbox,
+        "transportationMode",
+      ],
+    },
+    steps: {
+      type: "boolean",
+      label: "Steps",
+      description: "Whether to return steps and turn-by-turn instructions (`true`) or not (`false`, default)",
+      optional: true,
+    },
+    alternatives: {
+      type: "boolean",
+      label: "Alternatives",
+      description: "Whether to try to return alternative routes (`true`) or not (`false`, default). An alternative route is a route that is significantly different from the fastest route, but still close in time.",
+      optional: true,
+    },
+    exclude: {
+      propDefinition: [
+        mapbox,
+        "exclude",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const directions = await this.mapbox.getDirections({
+      $,
+      transportationMode: this.transportationMode,
+      coordinates: `${this.startCoordinate};${this.endCoordinate}`,
+      params: {
+        steps: this.steps,
+        alternatives: this.alternatives,
+        exclude: this.exclude && this.exclude.join(","),
+      },
+    });
+    $.export("$summary", "Generated directions successfully.");
+    return directions;
+  },
+};

package/actions/geocode-address/geocode-address.mjs

@@ -0,0 +1,41 @@
+import mapbox from "../../mapbox.app.mjs";
+
+export default {
+  key: "mapbox-geocode-address",
+  name: "Geocode Address",
+  description: "Retrieves the geocoded location for a given address. [See the documentation](https://docs.mapbox.com/api/search/geocoding/)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    mapbox,
+    address: {
+      type: "string",
+      label: "Address",
+      description: "The address (or partial address) to geocode. This could be an address, a city name, etc. Must consist of at most 20 words and numbers separated by spacing and punctuation, and at most 256 characters.",
+    },
+    boundingBox: {
+      type: "string",
+      label: "Bounding Box",
+      description: "Limit results to only those contained within the supplied bounding box. Bounding boxes should be supplied as four numbers separated by commas, in `minLon,minLat,maxLon,maxLat` order. The bounding box cannot cross the 180th meridian. You can use the [Location Helper](https://labs.mapbox.com/location-helper) to find a bounding box for use with this API.",
+      optional: true,
+    },
+    proximity: {
+      type: "string",
+      label: "Proximity",
+      description: "Bias the response to favor results that are closer to this location. Provided as two comma-separated coordinates in `longitude,latitude` order.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.mapbox.geocode({
+      $,
+      params: {
+        q: this.address,
+        bBox: this.boundingBox,
+        proximity: this.proximity,
+      },
+    });
+    $.export("$summary", `Geocoded location for "${this.address}" retrieved successfully`);
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,21 @@
+const TRANSPORTATION_MODES = [
+  "driving",
+  "walking",
+  "cycling",
+  "driving-traffic",
+];
+
+const EXCLUDE_OPTIONS = [
+  "motorway",
+  "toll",
+  "ferry",
+  "unpaved",
+  "cash_only_tolls",
+  "country_border",
+  "state_border",
+];
+
+export default {
+  TRANSPORTATION_MODES,
+  EXCLUDE_OPTIONS,
+};

package/mapbox.app.mjs

@@ -0,0 +1,81 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
+export default {
+  type: "app",
+  app: "mapbox",
+  propDefinitions: {
+    transportationMode: {
+      type: "string",
+      label: "Transportation Mode",
+      description: "The mode of transportation",
+      options: constants.TRANSPORTATION_MODES,
+    },
+    exclude: {
+      type: "string[]",
+      label: "Exclude",
+      description: "Exclude certain road types and custom locations from routing",
+      options: constants.EXCLUDE_OPTIONS,
+      optional: true,
+    },
+  },
+  methods: {
+    _baseUrl() {
+      return "https://api.mapbox.com";
+    },
+    _makeRequest({
+      $ = this,
+      path,
+      params,
+      ...otherOpts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        params: {
+          access_token: this.$auth.access_token,
+          ...params,
+        },
+        ...otherOpts,
+      });
+    },
+    geocode(opts = {}) {
+      return this._makeRequest({
+        path: "/search/geocode/v6/forward",
+        ...opts,
+      });
+    },
+    getDirections({
+      transportationMode, coordinates, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/directions/v5/mapbox/${transportationMode}/${coordinates}`,
+        ...opts,
+      });
+    },
+    createTilesetSource({
+      username, id, ...opts
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/tilesets/v1/sources/${username}/${id}`,
+        ...opts,
+      });
+    },
+    validateRecipe(opts = {}) {
+      return this._makeRequest({
+        method: "PUT",
+        path: "/tilesets/v1/validateRecipe",
+        ...opts,
+      });
+    },
+    createTileset({
+      tilesetId, ...opts
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/tilesets/v1/${tilesetId}`,
+        ...opts,
+      });
+    },
+  },
+};

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@pipedream/mapbox",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Pipedream Mapbox Components",
-  "main": "dist/app/mapbox.app.mjs",
+  "main": "mapbox.app.mjs",
   "keywords": [
     "pipedream",
     "mapbox"
   ],
-  "files": [
-    "dist"
-  ],
   "homepage": "https://pipedream.com/apps/mapbox",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
-  "license": "MIT",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.3",
+    "form-data": "^4.0.1"
   }
 }