@lota-sdk/core 0.1.5

package/src/db/record-id.ts

@@ -0,0 +1,78 @@
+import type { RecordIdValue } from 'surrealdb'
+import { RecordId, StringRecordId } from 'surrealdb'
+
+import { BadRequestError } from '../utils/errors'
+
+export interface RecordIdShape {
+  tb: string
+  id: RecordIdValue
+}
+
+export interface StringableRecordId {
+  toString(): string
+}
+
+export type RecordIdInput = string | RecordId | StringRecordId | RecordIdShape | StringableRecordId
+
+export type RecordIdRef = RecordIdInput
+
+class InvalidRecordIdError extends BadRequestError {
+  constructor(message: string) {
+    super(message)
+    this.name = 'InvalidRecordIdError'
+  }
+}
+
+export function readCustomStringValue(value: object): string | null {
+  const toStringValue: unknown = Reflect.get(value, 'toString')
+  if (typeof toStringValue !== 'function' || toStringValue === Object.prototype.toString) {
+    return null
+  }
+
+  const stringValue = Reflect.apply(toStringValue as (this: object) => unknown, value, [])
+  if (typeof stringValue !== 'string' || stringValue.length === 0) {
+    return null
+  }
+
+  return stringValue
+}
+
+export function ensureRecordId(value: RecordIdInput, fallbackTable?: string): RecordId {
+  if (value instanceof RecordId) {
+    return value
+  }
+
+  if (value instanceof StringRecordId) {
+    return ensureRecordId(value.toString(), fallbackTable)
+  }
+
+  if (typeof value === 'string') {
+    const tableIdMatch =
+      value.match(/^([a-zA-Z][a-zA-Z0-9_]*):⟨(.+)⟩$/) ?? value.match(/^([a-zA-Z][a-zA-Z0-9_]*):(.+)$/)
+    if (tableIdMatch) {
+      return new RecordId(tableIdMatch[1], tableIdMatch[2])
+    }
+    if (!fallbackTable) {
+      throw new InvalidRecordIdError('Missing table for record id')
+    }
+    return new RecordId(fallbackTable, value)
+  }
+
+  if (typeof value === 'object') {
+    const record = value as { tb?: string; id?: RecordIdValue }
+    if (record.tb && record.id !== undefined) {
+      return new RecordId(record.tb, record.id)
+    }
+
+    const stringValue = readCustomStringValue(value)
+    if (stringValue && stringValue !== '[object Object]') {
+      return ensureRecordId(stringValue, fallbackTable)
+    }
+  }
+
+  throw new InvalidRecordIdError('Invalid record id value')
+}
+
+export function recordIdToString(value: RecordIdInput, fallbackTable?: string): string {
+  return ensureRecordId(value, fallbackTable).toString()
+}