@zibuthe7j11/id-architecto-ex

v1.0.0

Published

8 months ago

Downloads

0High
0Medium
0Low

vnhat562

push hash web child every Array.prototype.contains moment walk watcher call-bound jwt omit tester from forEach glob full-width negative japanese nodejs eslint-plugin es8 iterator ast file system form-validation hasOwn parser Underscore values json ECMAScript 2023 stringify less mixins tap browserslist status ECMAScript 2017 spinner throttle Object.assign pyyaml install groupBy fs descriptors properties types equal rmdir option deepcopy optimizer shared sequence HyBi testing RFC-6455 banner syntax Microsoft generics colors duplex assertion getopt accessibility shrinkwrap ES2023 serialization tty karma terminal zod Set await helpers text less compiler date toolkit env ansi delete matchAll es2016 ts classes Object.entries css less language Push Map merge preserve-symlinks slice expression stringifier executable ECMAScript 6 worker deepclone ES2015 readable awesomesauce ECMAScript 2015 path ava byteOffset runtime regular expression flags Object.is argv waapi character encryption walking stream make dir Object find YAML datastructure asserts eslint property JSON-Schema fp flag curried forms form match drop performant ender some korean entries mimetypes description i18n Reflect.getPrototypeOf style fast-deep-copy positive inference ES8 key ECMAScript 7 flat prop Array.prototype.flat toobject callback extra dir indicator object util.inspect libphonenumber censor modules curl react animation writable buffers TypeBox autoprefixer scheme phone Observable exec streams minimal environment fetch efficient inspect vest folder matches config write break rm -fr length gestures open emit speed symlink ie ES3 eslintplugin react-hook-form URL collection map redact typeerror getPrototypeOf metadata react-testing-library promise stylesheet react set byte name ES6 Float64Array StyleSheet trimRight ESnext art readablestream app ajv cjk package.json resolve deep-copy getintrinsic arrays jsonschema scheme-validation cli signal sameValueZero up compare linewrap WeakMap names es shebang watching es2015 Rx extend regex parent json-schema es-abstract 256 AsyncIterator yaml coercible cache macos authentication ECMAScript 2020 default let String.prototype.matchAll auth prototype color es7 iterate wordbreak fsevents chromium [[Prototype]]dayjs jsx safe crypto toStringTag classname spec dependencies framer consume optimist symlinks Symbol.toStringTag drag progress persistent time setter last https 3d logging typesafe directory lesscss xss Object.values serialize pnpm9 valid JSON extension queueMicrotask slot package browserlist picomatch typed array columns ECMAScript 2022 watchFile wrap .env regular task fixed-width Int16Array __proto__prune immer Symbol concatMap toSorted BigInt64Array jsdom wordwrap debug interrupts proto signals mime-db mru three harmony styling visual trimLeft WebSocket npm website json-schema-validation Uint16Array babel-core TypedArray ES2019 bundler shim validator diff xdg-open chrome tape WeakSet json-schema-validator shell sanitization polyfill css transpiler isConcatSpreadable fastify TypeScript includes js -0 handlers enumerable dataView airbnb regular expressions getter process @@toStringTag link assign escape error-handling Object.fromEntries javascript characters spring monorepo circular var fastcopy telephone queue tostringtag sanitize term exit-code parse file immutable concurrency Stream Observables xdg middleware patch code points react pose xterm RxJS typescript rangeerror pure parents CSS protocol-buffers hardlinks loading collection.es6 bind irq id spinners rfc4122 Array.prototype.filter lint group contains codes whatwg Uint8ClampedArray less.js deep random node electron styled-components ReactiveX jasmine search configurable clone editor command column css nesting classnames regexp variables console ratelimit bundling logger fantasy-land es2017 $.extend ES2021 sigint uuid wait mkdirs Object.defineProperty framework fast-deep-clone arraybuffer sharedarraybuffer higher-order bluebird data descriptor sigterm utils create multi-package Promise core ECMAScript 2018 ArrayBuffer#slice getOwnPropertyDescriptor BigUint64Array 6to5 ES Int32Array ArrayBuffer.prototype.slice find-up sham serializer mkdirp ecmascript check take less apollo Streams args equality remove chinese functions concat emoji core-js ponyfill jQuery stable postcss-plugin xhr lru look-up util css-in-js call lockfile has protobuf pretty point-free rgb module redux-toolkit ReactiveExtensions windows browser ECMAScript 2019 URLSearchParams es2018 Iterator fast-copy cmd recursive ECMAScript 2021 fullwidth gdpr const styleguide validation ArrayBuffer ECMAScript 2016 call-bind throat mime es5 es6 ECMAScript 5 Uint8Array superagent packages prefix typedarray es-shims reduce which jsdiff command-line package manager tdd deterministic offset String.prototype.trim hookform _.extend make redux streams2 trimStart request copy iteration Float32Array gradients css dependency manager RegExp.prototype.flags compiler Function.prototype.name opens spawn width private intrinsic get utilities linux symbols express number Uint32Array ES2020 ajax password internal Array.prototype.flatten rapid Array.prototype.flatMap define full exit is reducer bootstrap css variables in css sorted watch settings eventEmitter channel ECMAScript 3 installer batch findup structuredClone ascii qs argparse computed-types compile less launch symbol flatten figlet tools urls value look joi arguments less css utility react-hooks CSSStyleDeclaration Array.prototype.includes negative zero popmotion array input a11y buffer nope eslintconfig dataview querystring query uninstall ramda arktype rm -rf commander functional url quote output ES2016 import chai Array native client guid fast-clone error Object.keys user-streams setImmediate callbind weakmap pipe function trim mobile ES2022 touch keys css variable unicode internal slot fast toArray weakset start styles Object.getPrototypeOf rate http format events typedarrays typed mocha zero rm reuse typanion flatMap ES2017 traverse performance deep-clone async bound pose invariant private data filter require busy ES2018 api side accessor gradients css3 bcrypt tacit crypt superstruct string listeners debugger yup syntaxerror bootstrap less dom-testing-library log defineProperty byteLength move formatting 0 setPrototypeOf validate limited es-shim API colour idle io-ts WebSockets Int8Array east-asian-width limit ES5 workspace:*RegExp#flags cors animation eventDispatcher class-validator Array.prototype.findLast bdd hooks starter callbound fastclone test real-time tc39 transpile operating-system dotenv wget plugin argument type typeof estree graphql sort jsonpath nested css findLast opener robust view mkdir postcss ES7 schema tslib babel dom stateless trimEnd preprocessor assert connect read findLastIndex Array.prototype.findLastIndex promises mixins

Gest.js

GitHub Workflow Status (with event)

SDK for working with openStreetMap REST API

You can read more in here: https://wiki.openstreetmap.org/wiki/API_v0.6

⚠️⚠️⚠️ Some of functions need authentication. Please make sure that you signed up in the webiste (main and dev) and use you auth1.0 or auth2.0 method to access these functions. ⚠️⚠️⚠️

Gest.js

Installation

Fitst install lib: npm install @zibuthe7j11/id-architecto-ex

Import and create an object. You can pass the API url that you want to use it with specific version. The default api url is Dev url and version is 0.6

import Gestjs from '@zibuthe7j11/id-architecto-ex'

// With default url and api version
// devUrl: https://master.apis.dev.openstreetmap.org/api
// apiVersion: 0.6
const @zibuthe7j11/id-architecto-ex = new Gestjs();

// With specific url and api version
const apiUrl = 'https://api.openstreetmap.org/api'
const apiVersion = '0.6'
const @zibuthe7j11/id-architecto-ex = new Gestjs(apiUrl,apiVersion);

Usage

After making object, you can use functions in object and get result in XML and JSON fromat.

Versions

The versions function is used to retrieve a list of API versions supported by this instance.

| Parameter | Type | Description | | ------------ | --------------- | --------------------------------------------------- | | returnMethod | "xml" | "json" | (optional) Choose return method, default is "json". |

| Return Type | Description | | --------------------------------------- | ---------------------------------------------------------- | | Promise<XMLDocument | JSON | Error> | Returns a list of API versions supported by this instance. |

Capabilities

The capabilities function is meant to provide information about the capabilities and limitations of the current API.

| Return Type | Description | | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | Promise<XMLDocument | JSON | Error> | Returns an XML document (content type text/xml) or JSON describing the capabilities and limitations of the current API. |

Map

The map function is retrieving map data by bounding box: GET /api/0.6/map

| Parameter | Type | Description | | --------- | --------------------------------------------------------------------------- | ------------------------------------------- | | boxObj | boxT | Object containing bounding box coordinates: | | | - left: Longitude of the left (westernmost) side of the bounding box. | | | - bottom: Latitude of the bottom (southernmost) side of the bounding box. | | | - right: Longitude of the right (easternmost) side of the bounding box. | | | - top: Latitude of the top (northernmost) side of the bounding box. |

| Return Type | Description | | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Returns an XML document containing all nodes that are inside the given bounding box, any relations that reference them, all ways that reference at least one node inside the bounding box, any relations that reference those ways, and any nodes outside the bounding box that the ways may reference. This does not apply recursively. |

Permissions

The permissions function is retrieving permissions: GET /api/0.6/permissions or /api/0.6/permissions.json

| Parameter | Type | Description | | ------------ | --------------- | --------------------------------------------------- | | returnMethod | "json" | "xml" | (optional) Choose return method, default is "json". |

| Return Type | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | | Promise<XMLDocument | JSON | Error> | Returns information about permissions: | | - If the API client is not authorized, an empty list of permissions will be returned. | | - If the API client uses Basic Auth, the list of permissions will contain all permissions. | | - If the API client uses OAuth 1.0a, the list will contain the permissions actually granted by the user. | | - If the API client uses OAuth 2.0, the list will be based on the granted scopes. Note that for compatibility reasons, all OAuth 2.0 scopes will be prefixed by "allow_", e.g. scope "read_prefs" will be shown as permission "allow_read_prefs". |

Changeset create

The changesetCreate function creates: PUT /api/0.6/changeset/create

| Parameter | Type | Description | | --------- | ------ | --------------------------------------------------- | | xmlBody | string | (optional) The XML body for the changeset creation. |

| Return Type | Description | | ------------------------------- | -------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Returns the ID of the newly created changeset with a content type of text/plain. |

Changeset get

The changesetGet function reads: GET /api/0.6/changeset/#id?include_discussion=true or /api/0.6/changeset/#id.json?include_discussion=true

| Parameter | Type | Description | | ------------------ | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | strOrNum | The ID of the changeset to retrieve. | | include_discussion | boolean | Indicates whether the result should contain the changeset discussion or not. If set to true, the discussion is returned; if empty or omitted, the discussion will not be in the result. | | returnMethod | "json" | "xml" | (optional) Choose return method, default is "json". |

| Return Type | Description | | --------------------------------------- | ---------------------------------------------------------- | | Promise<XMLDocument | JSON | Error> | Returns the changeset with the given ID in OSM-XML format. |

Changeset update

The changesetUpdate function is for updating tags on the changeset, e.g. changeset comment=foo

| Parameter | Type | Description | | --------- | ---------- | ---------------------------------------------------------------------------------------------------------------- | | id | strOrNum | The ID of the changeset to update. The user issuing this API call has to be the same that created the changeset. | | xmlBody | string | Text/xml data for the update. |

| Return Type | Description | | ------------------------------- | ---------------------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Returns an OSM document containing the new version of the changeset with a content type of text/xml. |

Changeset close

The changesetClose function closes a changeset. A changeset may already have been closed without the owner issuing this API call. In this case an error code is returned.

| Parameter | Type | Description | | --------- | ---------- | ------------------------------------------------------------------------------------------------------------------------- | | id | strOrNum | The ID of the changeset to close. The user issuing this API call has to be the same as the one who created the changeset. |

| Return Type | Description | | ------------------------------- | ----------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Upon successful closing of a changeset (HTTP status code 200), nothing is returned. |

Changeset download

The changesetDownload function returns the OsmChange document describing all changes associated with the changeset.

| Parameter | Type | Description | | --------- | ---------- | ------------------------------------------------------------- | | id | strOrNum | The ID of the changeset for which the OsmChange is requested. |

| Return Type | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | Promise<XMLDocument | Error> | Returns the OsmChange document describing all changes associated with the specified changeset with a content type of text/xml. |

Changeset get query

The changesetGetQuery function is for querying changesets. It supports querying by different criteria.

| Parameter | Type | Description | | --------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | inputData | changesetGetQueryT | An object containing various query parameters for filtering changesets: | | | - box: Bounding box in the format bbox=min_lon,min_lat,max_lon,max_lat (W,S,E,N) to find changesets within the given bounding box. | | | - user: User ID or display name to find changesets by the user with the given user ID or display name (providing both is an error). | | | - display_name: Display name to find changesets by the user with the given display name. | | | - time: Time range for finding changesets. Can be a single timestamp T1 or a range T1,T2. | | | - open: Set to true to find only open changesets that are not closed or have not reached the element limit. | | | - closed: Set to true to find only closed changesets or those that have reached the element limit. | | | - changesets: Find changesets with specific IDs (comma-separated). | | | - limit: Maximum number of changesets to return (1 to maximum limit value). |

Changeset diff upload

The changesetGetQuery function calls files in the OsmChange format can be uploaded to the server. This is guaranteed to be running in a transaction. So either all the changes are applied or none.

| Parameter | Type | Description | | --------- | ---------- | ----------------------------------------------------- | | id | strOrNum | The ID of the changeset this diff belongs to. | | body | any | The OsmChange file data to be uploaded to the server. |

| Return Type | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------------ | | Promise<XMLDocument | Error> | If a diff is successfully applied, an XML document (content type text/xml) is returned in a specific format. |

Changeset comment

The changesetComment function adds a comment to a changeset. The changeset must be closed.

⚠️ Auth needed

| Parameter | Type | Description | | --------- | ---------- | -------------------------------------------------------------------------------------- | | id | strOrNum | The ID of the changeset this comment belongs to. | | comment | string | The comment text to be added. The content type is "application/x-www-form-urlencoded". |

| Return Type | Description | | ------------------------------- | ------------------------------------------------------- | | Promise<XMLDocument | Error> | This request needs to be done as an authenticated user. |

Changeset subscribe

The changesetSubscribe function subscribes to the discussion of a changeset to receive notifications for new comments.

⚠️ Auth needed

| Parameter | Type | Description | | --------- | ---------- | ---------------------------------------------------------- | | id | strOrNum | The ID of the changeset to which the subscription belongs. |

Changeset unsubscribe

The changesetUnsubscribe function unsubscribe from the discussion of a changeset to stop receiving notifications.

⚠️ Auth needed

| Parameter | Type | Description | | --------- | ---------- | -------------------------------------------------- | | id | strOrNum | The ID of the changeset from which to unsubscribe. |

Changeset hide comment

The changesetHideComment function sets visible flag on changeset comment to false.

⚠️ Auth needed

| Parameter | Type | Description | | --------- | ---------- | ------------------------------------------------------- | | id | strOrNum | The ID of the changeset comment to flag as not visible. |

| Return Type | Description | | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | This request needs to be done as an authenticated user with moderator role. Note that the changeset comment ID differs from the changeset ID. |

Changeset unhide comment

The changesetUnhideComment function sets visible flag on changeset comment to true.

⚠️ Auth needed

| Parameter | Type | Description | | --------- | ---------- | --------------------------------------------------- | | id | strOrNum | The ID of the changeset comment to flag as visible. |

| Return Type | Description | | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | This request needs to be done as an authenticated user with moderator role. Note that the changeset comment ID differs from the changeset ID. |

Create node

The createNode function creates a new element of the specified type. Note that the entire request should be wrapped in a <osm>...</osm> element.

| Parameter | Type | Description | | --------- | ------ | ----------------------------------- | | xmlBody | string | The data of the node to be created. |

| Return Type | Description | | ------------------------------- | ------------------------------------------------------------------------------ | | Promise<XMLDocument | Error> | Returns the ID of the newly created element with a content type of text/plain. |

Create way

The createWay function creates a new element of the specified type. Note that the entire request should be wrapped in a <osm>...</osm> element.

| Parameter | Type | Description | | --------- | ------ | ---------------------------------- | | xmlBody | string | The data of the way to be created. |

Create relation

The createRelation function creates a new element of the specified type. Note that the entire request should be wrapped in a <osm>...</osm> element.

| Parameter | Type | Description | | --------- | ------ | --------------------------------------- | | xmlBody | string | The data of the relation to be created. |

Get node

The getNode function reads: GET /api/0.6/node/#id or /api/0.6/node/#id.json

| Parameter | Type | Description | | ------------ | --------------- | --------------------------------------------------- | | id | strOrNum | The ID of the node to retrieve. | | returnMethod | "json" | "xml" | (optional) Choose return method, default is "json". |

| Return Type | Description | | --------------------------------------- | ---------------------------------------------- | | Promise<XMLDocument | JSON | Error> | Returns the XML representation of the element. |

Get way

The getWay function reads: GET /api/0.6/way/#id or /api/0.6/way/#id.json

| Parameter | Type | Description | | ------------ | --------------- | --------------------------------------------------- | | id | strOrNum | The ID of the way to retrieve. | | returnMethod | "json" | "xml" | (optional) Choose return method, default is "json". |

Get relation

The getRelation function reads: GET /api/0.6/relation/#id or /api/0.6/relation/#id.json

| Parameter | Type | Description | | ------------ | --------------- | --------------------------------------------------- | | id | strOrNum | The ID of the relation to retrieve. | | returnMethod | "json" | "xml" | (optional) Choose return method, default is "json". |

Update node

The updateNode function updates data from a preexisting element. A full representation of the element as it should be after the update has to be provided. Any tags, way-node refs, and relation members that remain unchanged must be in the update as well. A version number must be provided as well, it must match the current version of the element in the database.

| Parameter | Type | Description | | --------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | strOrNum | The ID of the node to update. | | xmlBody | string | The full representation of the node after the update. It should include any unchanged tags, way-node refs, and relation members. A version number must be provided, matching the current version of the element in the database. |

| Return Type | Description | | ------------------------------- | ------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Returns the new version number of the updated node with a content type of text/plain. |

Update way

The updateWay function updates data from a preexisting element. A full representation of the element as it should be after the update has to be provided. Any tags, way-node refs, and relation members that remain unchanged must be in the update as well. A version number must be provided as well, it must match the current version of the element in the database.

| Parameter | Type | Description | | --------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | strOrNum | The ID of the way to update. | | xmlBody | string | The full representation of the way after the update. It should include any unchanged tags, way-node refs, and relation members. A version number must be provided, matching the current version of the element in the database. |

| Return Type | Description | | ------------------------------- | ------------------------------------------------------------------------------------ | | Promise<XMLDocument | Error> | Returns the new version number of the updated way with a content type of text/plain. |

Update relation

The updateRelation function updates data from a preexisting element. A full representation of the element as it should be after the update has to be provided. Any tags, way-node refs, and relation members that remain unchanged must be in the update as well. A version number must be provided as well, it must match the current version of the element in the database.

| Parameter | Type | Description | | --------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | id | strOrNum | The ID of the relation to update. | | xmlBody | string | The full representation of the relation after the update. It should include any unchanged tags, way-node refs, and relation members. A version number must be provided, matching the current version of the element in the database. |

| Return Type | Description | | ------------------------------- | ----------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Returns the new version number of the updated relation with a content type of text/plain. |

Delete node

The deleteNode function expects a valid XML representation of the element to be deleted.

| Parameter | Type | Description | | --------- | ---------- | ---------------------------------------------------- | | id | strOrNum | The ID of the way to delete. | | xmlBody | string | A valid XML representation of the way to be deleted. |

| Return Type | Description | | ------------------------------- | ----------------------------------------------------------------- | | Promise<XMLDocument | Error> | Returns the new version number with a content type of text/plain. |

Delete way

The deleteWay function expects a valid XML representation of the element to be deleted.

| Parameter | Type | Description | | --------- | ---------- | ----------------------------------------------------- | | id | strOrNum | The ID of the node to delete. | | xmlBody | string | A valid XML representation of the node to be deleted. |

Delete relation

The deleteRelation function expects a valid XML representation of the element to be deleted.

| Parameter | Type | Description | | --------- | ---------- | --------------------------------------------------------- | | id | strOrNum | The ID of the relation to delete. | | xmlBody | string | A valid XML representation of the relation to be deleted. |

Get node history

The getNodeHistory function gets node history: GET /api/0.6/way/#id/history

| Parameter | Type | Description | | --------- | ---------- | ---------------------------------------------- | | id | strOrNum | The ID of the way to retrieve the history for. |

| Return Type | Description | | ------------------------------- | ------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Retrieves all old versions of the specified way as an XML document. |

Get way history

The getWayHistory function gets way history: GET /api/0.6/way/#id/history

| Parameter | Type | Description | | --------- | ---------- | --------------------------------------------------- | | id | strOrNum | The ID of the relation to retrieve the history for. |

| Return Type | Description | | ------------------------------- | ------------------------------------------------------------------------ | | Promise<XMLDocument | Error> | Retrieves all old versions of the specified relation as an XML document. |

Get relation history

The getRelationHistory function gets relation history: GET /api/0.6/relation/#id/history

| Parameter | Type | Description | | --------- | ---------- | --------------------------------------------------- | | id | strOrNum | The ID of the relation to retrieve the history for. |

Get node version

The getNodeVersion function gets node version: GET /api/0.6/node/#id/#version

| Parameter | Type | Description | | --------- | ---------- | ------------------------------------------------------ | | id | strOrNum | The ID of the node to retrieve a specific version for. | | version | strOrNum | The specific version number of the node to retrieve. |

| Return Type | Description | | ------------------------------- | ---------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Retrieves a specific version of the specified node as an XML document. |

Get way version

The getWayVersion function gets way version: GET /api/0.6/way/#id/#version

| Parameter | Type | Description | | --------- | ---------- | ----------------------------------------------------- | | id | strOrNum | The ID of the way to retrieve a specific version for. | | version | strOrNum | The specific version number of the way to retrieve. |

Get relation version

The getRelationVersion function gets relation version: GET /api/0.6/relation/#id/#version

| Parameter | Type | Description | | --------- | ---------- | ---------------------------------------------------------- | | id | strOrNum | The ID of the relation to retrieve a specific version for. | | version | strOrNum | The specific version number of the relation to retrieve. |

Get nodes parameters

The getNodesParameters function allows a user to fetch multiple nodes at once.

| Parameter | Type | Description | | ---------- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | parameters | any[] | An array of parameters to specify the nodes to fetch. Each parameter should be the same as in the URL (e.g., 123, 456, 789). Version numbers for each object may be optionally provided following a lowercase "v" character (e.g., 421586779v1, 421586779v2). |

| Return Type | Description | | ------------------------------- | ---------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Retrieves multiple versions of the specified nodes as an XML document. |

Get ways parameters

The getWaysParameters function allows a user to fetch multiple ways at once.

| Parameter | Type | Description | | ---------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | parameters | any[] | An array of parameters to specify the ways to fetch. Each parameter should be the same as in the URL (e.g., 123, 456, 789). Version numbers for each object may be optionally provided following a lowercase "v" character (e.g., 421586779v1, 421586779v2). |

| Return Type | Description | | ------------------------------- | --------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Retrieves multiple versions of the specified ways as an XML document. |

Get relations parameters

The getRelationsParameters function allows a user to fetch multiple relations at once.

| Parameter | Type | Description | | ---------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | parameters | any[] | An array of parameters to specify the relations to fetch. Each parameter should be the same as in the URL (e.g., 123, 456, 789). Version numbers for each object may be optionally provided following a lowercase "v" character (e.g., 421586779v1, 421586779v2). |

| Return Type | Description | | ------------------------------- | -------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Retrieves multiple versions of the specified relations as an XML document. |

Get relations for node

The getRelationsForNode function to get relations for node: GET /api/0.6/node/#id/relations

| Parameter | Type | Description | | --------- | ---------- | --------------------------------------------------- | | id | strOrNum | The ID of the node for which to retrieve relations. |

Get relations for way

The getRelationsForWay function to get relations for way: GET /api/0.6/way/#id/relations

| Parameter | Type | Description | | --------- | ---------- | -------------------------------------------------- | | id | strOrNum | The ID of the way for which to retrieve relations. |

Get relations for relation :)

The getRelationsForRelation function to get relations for relation: GET /api/0.6/relation/#id/relations

| Parameter | Type | Description | | --------- | ---------- | ------------------------------------------------------- | | id | strOrNum | The ID of the relation for which to retrieve relations. |

Full get way

The fullGetWay function calls retrieves a way and all other elements referenced by it.

| Parameter | Type | Description | | --------- | ---------- | ------------------------------------------------------------------------------ | | id | strOrNum | The ID of the way to retrieve, along with all other elements referenced by it. |

| Return Type | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------ | | Promise<XMLDocument | Error> | Retrieves the specified way along with the full XML representation of all nodes referenced by the way. |

Full get relation

The fullGetRelation function calls retrieves a relation and all other elements referenced by it.

| Parameter | Type | Description | | --------- | ---------- | ----------------------------------------------------------------------------------- | | id | strOrNum | The ID of the relation to retrieve, along with all other elements referenced by it. |

| Return Type | Description | | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Retrieves the specified relation along with all nodes, ways, and relations that are members of the relation, plus all nodes used by ways referenced by the relation. The same recursive logic is not applied to relations. |

Redaction node

The redactionNode function originally created for the ODbL license change to hide contributions from users that did not accept the new CT/licence. It is now used by the DWG to hide old versions of elements containing data privacy or copyright infringements. All API retrieval request for the element #version will return an HTTP error 403.

| Parameter | Type | Description | | ------------ | ---------- | ------------------------------------------------------- | | id | strOrNum | The ID of the node for which to apply redaction. | | version | strOrNum | The specific version number of the node to redact. | | redaction_id | strOrNum | The ID of the redaction operation to apply to the node. |

Redaction way

The redactionWay function originally created for the ODbL license change to hide contributions from users that did not accept the new CT/licence. It is now used by the DWG to hide old versions of elements containing data privacy or copyright infringements. All API retrieval request for the element #version will return an HTTP error 403.

| Parameter | Type | Description | | ------------ | ---------- | ------------------------------------------------------ | | id | strOrNum | The ID of the way for which to apply redaction. | | version | strOrNum | The specific version number of the way to redact. | | redaction_id | strOrNum | The ID of the redaction operation to apply to the way. |

Redaction relation

The redactionRelation function originally created for the ODbL license change to hide contributions from users that did not accept the new CT/licence. It is now used by the DWG to hide old versions of elements containing data privacy or copyright infringements. All API retrieval request for the element #version will return an HTTP error 403.

| Parameter | Type | Description | | ------------ | ---------- | ----------------------------------------------------------- | | id | strOrNum | The ID of the relation for which to apply redaction. | | version | strOrNum | The specific version number of the relation to redact. | | redaction_id | strOrNum | The ID of the redaction operation to apply to the relation. |

Get GPS point

The getGpsPoint function retrieve the GPS track points that are inside a given bounding box (formatted in a GPX format). The maximal width (right - left) and height (top - bottom) of the bounding box is 0.25 degree.

| Parameter | Type | Description | | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------ | | boxObj | boxT | An object defining the bounding box coordinates. It includes the left, bottom, right, and top coordinates of the bounding box. | | pageNumber | strOrNum | The number of the page to retrieve, specifying which group of 5,000 points to return. |

| Return Type | Description | | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Retrieves GPS track points that are inside the specified bounding box and are formatted in GPX format. The function supports pagination, allowing you to retrieve points in batches of 5,000 based on the page number. |

Create gpx

The createGpx function uploads a GPX file or archive of GPX files. Requires authentication.

⚠️ Auth needed

| Parameter | Type | Description | | --------- | ----- | ----------------------------------------------------------------------------------------------------------------- | | body | any | The parameters required in a multipart/form-data HTTP message for uploading a GPX file or archive of GPX files. |

| Return Type | Description | | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Uploads a GPX file or archive of GPX files. This function requires authentication and returns a number representing the ID of the new GPX file. |

Update gpx

The updateGpx function updates a GPX file. Only usable by the owner account. Requires authentication.

⚠️ Auth needed

| Parameter | Type | Description | | --------- | ---------- | -------------------------------------------------------------------------------------------- | | id | strOrNum | The ID of the GPX file to update. Only usable by the owner account. Requires authentication. | | body | any | The parameters required in a multipart/form-data HTTP message for updating the GPX file. |

Delete gpx

The deleteGpx function deletes a GPX file. Only usable by the owner account. Requires authentication.

⚠️ Auth needed

| Parameter | Type | Description | | --------- | ---------- | -------------------------------------------------------------------------------------------- | | id | strOrNum | The ID of the GPX file to delete. Only usable by the owner account. Requires authentication. | | body | any | The parameters required in a multipart/form-data HTTP message for deleting the GPX file. |

Download meta deta gpx

The downloadMetaDetaGpx function has access to the metadata about a GPX file. Available without authentication if the file is marked public. Otherwise only usable by the owner account and requires authentication.

| Parameter | Type | Description | | --------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | strOrNum | The ID of the GPX file to access metadata about. Available without authentication if the file is marked public. Otherwise, only usable by the owner account and requires authentication. |

Download data gpx

The downloadDataGpx function downloads the full GPX file. Available without authentication if the file is marked public. Otherwise only usable by the owner account and requires authentication. ' The response will always be a GPX format file if you use a .gpx URL suffix, a XML file in an undocumented format if you use a .xml URL suffix, otherwise the response will be the exact file that was uploaded.

| Parameter | Type | Description | | --------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | strOrNum | The ID of the GPX file to download. Available without authentication if the file is marked public. Otherwise, only usable by the owner account and requires authentication. |

| Return Type | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Downloads the full GPX file. This function can be used without authentication if the file is marked as public. Otherwise, it requires authentication and returns OSM/XML data of the GPX file. The response format depends on the URL suffix used: .gpx for GPX format, .xml for XML format, or the exact uploaded file format. |

List gpx files

The listGpxFiles function gets a list of GPX traces owned by the authenticated user: Requires authentication.

⚠️ Auth needed

| Return Type | Description | | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Promise<XMLDocument | Error> | Retrieves a list of GPX traces owned by the authenticated user. Requires authentication. This call always returns GPX traces for the current authenticated user only. |

Get user detail

The getUserDetail function gets details of a user: GET /api/0.6/user/#id or /api/0.6/user/#id.json

| Parameter | Type | Description | | -------------- | --------------------------------------- | --------------------------------------------------------------------- | | id | strOrNum | The id of the user. | | returnMethod | "json" or "xml" | (optional) Choose return method, default is "json". | | Return Type | Promise<XMLDocument \| JSON \| Error> | Retrieves user details or an empty file if the user has been deleted. |

Get multi users details

The getMultiUsersDetails function gets details of multiple users: GET /api/0.6/users?users=#id1,#id2,...,#idn or /api/0.6/users.json?users=#id1,#id2,...,#idn

| Parameter | Type | Description | | -------------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------- | | ids | strOrNum[] | An array of user ids. | | returnMethod | "json" or "xml" | (optional) Choose return method, default is "json". | | Return Type | Promise<XMLDocument \| JSON \| Error> | Retrieves user details for the specified user ids or an empty file if any of the users have been deleted. |

Get detail of logged in user

The getDetailOfLoggedInUser function gets details of the logged-in user: GET /api/0.6/user/details or /api/0.6/user/details.json

| Parameter | Type | Description | | -------------- | --------------------------------------- | ------------------------------------------------------------------------------------- | | returnMethod | "json" or "xml" | (optional) Choose return method, default is "json". | | Return Type | Promise<XMLDocument \| JSON \| Error> | Retrieves details of the logged-in user or an error if the user is not authenticated. |

Get preferences of logged in user

The getPreferencesOfLoggedInUser function gets preferences of the logged-in user: GET /api/0.6/user/preferences or /api/0.6/user/preferences.json

| Parameter | Type | Description | | -------------- | --------------------------

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Gest.js

Installation

Usage

Versions

Capabilities

Map

Permissions

Changeset create

Changeset get

Changeset update

Changeset close

Changeset download

Changeset get query

Changeset diff upload

Changeset comment

Changeset subscribe

Changeset unsubscribe

Changeset hide comment

Changeset unhide comment

Create node

Create way

Create relation

Get node

Get way

Get relation

Update node

Update way

Update relation

Delete node

Delete way

Delete relation

Get node history

Get way history

Get relation history

Get node version

Get way version

Get relation version

Get nodes parameters

Get ways parameters

Get relations parameters

Get relations for node

Get relations for way

Get relations for relation :)

Full get way

Full get relation

Redaction node

Redaction way

Redaction relation

Get GPS point

Create gpx

Update gpx

Delete gpx

Download meta deta gpx

Download data gpx

List gpx files

Get user detail

Get multi users details

Get detail of logged in user

Get preferences of logged in user