feat: implement method to create a record link token

src/index.ts

@@ -23,6 +23,7 @@ export {
     ValidateNested,
     Contains,
     IsString,
+    Link,
 } from './lib';
 export type { Collection, ObjectId, JSONDocument } from './lib';
 export type {
@@ -44,4 +45,5 @@ export type {
     Subscription,
     Subscriber,
     MapFunction,
+    RecordLink,
 } from './types';

src/lib/Db/Link.ts

@@ -0,0 +1,24 @@
+/** @format */
+
+import { RecordLink } from '../../types';
+import { Collection } from './Collection';
+import { ObjectId } from './ObjectId';
+
+/**
+ * @description
+ * Method to create a **Record Link** token from a Collection and an Id.
+ *
+ * @param { string | Collection } collection - the namespace of a Collection or a Collection instance
+ * @param { ObjectId } recordId
+ * @returns
+ */
+
+export const Link = (collection: string | Collection<Record<PropertyKey, unknown>>, recordId: ObjectId): RecordLink => {
+    let namespace = collection;
+
+    if (collection instanceof Collection && 'namespace' in collection) {
+        namespace = collection.namespace;
+    }
+
+    return `${namespace}:${recordId.valueOf()}`;
+};

src/lib/Db/index.ts

@@ -5,3 +5,4 @@ export { Collection } from './Collection';
 export { ObjectId } from './ObjectId';
 export { JSONDocument } from './JSONDocument';
 export { Observable } from './Observable';
+export { Link } from './Link';

src/lib/index.ts

@@ -1,6 +1,6 @@
 /** @format */
 
-export { Flotsam, Collection, ObjectId, JSONDocument } from './Db';
+export { Flotsam, Collection, ObjectId, JSONDocument, Link } from './Db';
 export {
     Exactly,
     GreaterThan,

src/types/RecordLink.d.ts

@@ -0,0 +1,3 @@
+/** @format */
+
+export type RecordLink = `${string}:${string}`;

src/types/index.d.ts

@@ -27,3 +27,4 @@ export type { Subscriber } from './Subscriber';
 export type { MapFunction } from './MapFunction';
 export type { Handler } from './Handler';
 export type { ObservedQuery } from './ObservedQuery';
+export type { RecordLink } from './RecordLink';