add parseLocation and parseInstance

Author: LunyaaDev

.github/workflows/push-to-npm.yml

@@ -0,0 +1,24 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'pnpm'
+      - run: corepack enable
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm build # Build TypeScript files
+      - run: pnpm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'pnpm'
+      - run: corepack enable
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm build # Build TypeScript files

src/index.ts

@@ -1,3 +1,116 @@
-export const helloWorld = () => {
-  return 'hewwo :3'
-}
+interface InstanceBase {
+  worldId: string
+  name: string
+  region?: 'eu' | 'jp' | 'us' | 'use'
+  /**
+   * @deprecated Removed from VRChat instances
+   */
+  nonce?: string
+}
+
+interface InstancePublic extends InstanceBase {
+  type: 'public'
+}
+
+interface InstanceUser extends InstanceBase {
+  type: 'friends+' | 'friends' | 'invite+' | 'invite'
+  userId: string
+}
+
+interface InstanceGroup extends InstanceBase {
+  type: 'groupPublic' | 'group+' | 'group'
+  groupId: string
+  require18yo: boolean
+}
+
+type Instance = InstancePublic | InstanceUser | InstanceGroup
+
+/**
+ * Parses the location 
+ * @param location location string
+ * @returns obj with parsed location
+ */
+export const parseLocation = (location: string) => {
+
+  if(['offline', 'traveling', 'private', ''].includes(location))
+    return null;
+
+  const [worldId, instanceId] = location.split(':')
+  return parseInstance(worldId, instanceId)
+}
+
+/**
+ * Parses the instance 
+ * @param worldId id of the world
+ * @param instanceId instance string 
+ * @returns obj with parsed instance
+ */
+export const parseInstance = (worldId: string, instanceId: string) => {
+  // parse instance string
+  const instanceIdParts: { [key: string]: string | null } = Object.fromEntries(
+    instanceId.split('~').map((x) => {
+      const regexRes = x.match(/^(?<key>[^\(]+)(\((?<value>[^\)]+)\))?$/)
+      if (!regexRes?.groups?.key) {
+        return []
+      }
+      return [regexRes.groups.key, regexRes.groups.value || null]
+    }),
+  )
+
+  const instanceName = Object.keys(instanceIdParts).shift()
+  if (!instanceName) {
+    return null
+  }
+
+  // if nothing is set its public
+  let instance: Instance = {
+    worldId: worldId,
+    name: instanceName,
+    type: 'public',
+  }
+
+  if(instanceIdParts.region) {
+    instance.region = <Instance['region']>instanceIdParts.region
+  }
+
+  if(instanceIdParts.nonce) {
+    instance.nonce = instanceIdParts.nonce
+  }
+
+  // hidden(usr_00000000-0000-0000-0000-000000000000)
+  if (instanceIdParts.hidden) {
+    instance = {
+      ...instance,
+      type: 'friends+',
+      userId: instanceIdParts.hidden,
+    }
+  }
+  // friends(usr_00000000-0000-0000-0000-000000000000)
+  else if (instanceIdParts.friends) {
+    instance = {
+      ...instance,
+      type: 'friends',
+      userId: instanceIdParts.friends,
+    }
+  }
+  // private(usr_00000000-0000-0000-0000-000000000000)
+  // private(usr_00000000-0000-0000-0000-000000000000)~canRequestInvite
+  else if (instanceIdParts.private) {
+    instance = {
+      ...instance,
+      type: instanceIdParts.canRequestInvite ? 'invite+' : 'invite',
+      userId: instanceIdParts.private,
+    }
+  }
+  // group(grp_00000000-0000-0000-0000-000000000000)
+  else if (instanceIdParts.group) {
+    instance = {
+      ...instance,
+      type: instanceIdParts.groupAccessType == 'public' ? 'groupPublic' :  instanceIdParts.groupAccessType == 'plus' ? 'group+' : 'group',
+      groupId: instanceIdParts.group,
+      require18yo: 'ageGate' in instanceIdParts
+    }
+  }
+
+  return instance
+}