add formatInstanceId and formatLocation

Author: LunyaaDev

Readme.md

@@ -17,14 +17,23 @@ pnpm add vrchat-location-parser
 ## Usage
 
 ```ts
-import { parseInstance, parseLocation } from 'vrchat-location-parser'
+import {
+  parseInstance,
+  parseLocation,
+  formatLocation,
+} from 'vrchat-location-parser'
 
 parseLocation('wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd:12345~region(eu)')
 
 parseInstance('wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd', '12345~region(eu)')
 
+formatLocation({
+  worldId: 'wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd',
+  name: '12345',
+  type: 'public',
+})
 ```
 
 ## Contributing
-Pull requests are welcome! If you have any ideas, feel free to open an issue.
 
+Pull requests are welcome! If you have any ideas, feel free to open an issue.

example/package.json

@@ -13,6 +13,7 @@
   "devDependencies": {
     "@types/node": "^22.13.1",
     "nodemon": "^3.1.9",
+    "ts-node": "^10.9.2",
     "typescript": "^5.7.3"
   }
 }

example/pnpm-lock.yaml

@@ -1,4 +1,9 @@
-import { parseInstance, parseLocation } from 'vrchat-location-parser'
+import {
+  parseInstance,
+  parseLocation,
+  formatInstanceId,
+  formatLocation,
+} from 'vrchat-location-parser'
 
 console.log(
   parseLocation(
@@ -22,9 +27,19 @@ console.log(
   parseLocation('wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd:69420~region(us)'),
 )
 
+const instance = parseInstance(
+  'wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd',
+  '69420~region(us)',
+)
+
+console.log(instance)
+console.log(formatInstanceId(instance!))
+console.log(formatLocation(instance!))
+
 console.log(
-  parseInstance(
-    'wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd',
-    '69420~region(us)',
-  ),
+  formatLocation({
+    worldId: 'wrld_4432ea9b-729c-46e3-8eaf-846aa0a37fdd',
+    name: '12345',
+    type: 'public',
+  }),
 )

example/src/index.ts

@@ -1,6 +1,6 @@
 {
   "name": "vrchat-location-parser",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Parser for VRchat Locations",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package.json

@@ -0,0 +1,58 @@
+import type { Instance } from './interfaces/Instance'
+
+/**
+ * Format the instance from the instance object.
+ * @param instance instance object
+ * @returns object with worldId and instanceId
+ */
+export const formatInstanceId = (instance: Instance) => {
+  let instanceId = instance.name
+
+  // hidden(usr_00000000-0000-0000-0000-000000000000)
+  if (instance.type == 'friends+') {
+    instanceId += `~hidden(${instance.userId})`
+  }
+  // friends(usr_00000000-0000-0000-0000-000000000000)
+  else if (instance.type == 'friends') {
+    instanceId += `~friends(${instance.userId})`
+  }
+  // private(usr_00000000-0000-0000-0000-000000000000)
+  else if (instance.type == 'invite+') {
+    instanceId += `~private(${instance.userId})~canRequestInvite`
+  }
+
+  // private(usr_00000000-0000-0000-0000-000000000000)~canRequestInvite
+  else if (instance.type == 'invite') {
+    instanceId += `~private(${instance.userId})`
+  }
+  // group(grp_00000000-0000-0000-0000-000000000000)
+  else if (
+    instance.type == 'group' ||
+    instance.type == 'groupPublic' ||
+    instance.type == 'group+'
+  ) {
+    instanceId += `~group(${instance.groupId})`
+
+    if (instance.type == 'groupPublic') {
+      instanceId += '~groupAccessType(public)'
+    } else if (instance.type == 'group+') {
+      instanceId += '~groupAccessType(plus)'
+    } else {
+      instanceId += '~groupAccessType(members)'
+    }
+
+    if (instance.require18yo) {
+      instanceId += '~ageGate'
+    }
+  }
+
+  if (instance.region) {
+    instanceId += `~region(${instance.region})`
+  }
+
+  if (instance.nonce) {
+    instanceId += `~nonce(${instance.nonce})`
+  }
+
+  return instanceId
+}

src/formatInstanceId.ts

@@ -0,0 +1,11 @@
+import { formatInstanceId } from './formatInstanceId'
+import type { Instance } from './interfaces/Instance'
+
+/**
+ * Format the location string from the instance object.
+ * @param instance instance object
+ * @returns location string
+ */
+export const formatLocation = (instance: Instance) => {
+  return `${instance.worldId}:${formatInstanceId(instance)}`
+}

src/formatLocation.ts

@@ -1,3 +1,7 @@
 export { parseInstance } from './parseInstance'
 export { parseLocation } from './parseLocation'
-export { Instance } from './interfaces/Instance'
+
+export { formatInstanceId } from './formatInstanceId'
+export { formatLocation } from './formatLocation'
+
+export type { Instance } from './interfaces/Instance'

src/index.ts

@@ -1,4 +1,4 @@
-import { Instance } from './interfaces/Instance'
+import type { Instance } from './interfaces/Instance'
 
 /**
  * Parses the instance