feat(api): return ID from extractRailsId if it is already extracted

README.md

@@ -37,6 +37,15 @@ const id = 55587 || "55587";
 createRailsId(id, "Model") // -> gid://qeepsake-rails/Model/55587
 ```
 
+### Tetsing for Extracted Rails ID
+
+```js
+import { isExtractedRailsId } from '@qeepsake/rails-guid';
+
+isExtractedRailsId("55587") // => true
+isExtractedRailsId("gid://qeepsake-rails/Model/55587") // => false
+```
+
 ## License
 
 MIT © [lukebrandonfarrell](https://github.com/lukebrandonfarrell)

lib/extract-rails-id.js

@@ -1,4 +1,8 @@
+import { isExtractedRailsId } from './is-extracted-rails-id';
 export function extractRailsId(gid, stripTimestamp = false) {
+    // Checks if ID has already been extracted, if so, return it
+    if (gid && isExtractedRailsId(gid))
+        return gid;
     if (typeof gid === 'string' && (gid === null || gid === void 0 ? void 0 : gid.indexOf('/')) != -1) {
         const gidComponents = gid.split('/');
         let extractedId = gidComponents[gidComponents.length - 1];

lib/index.d.ts

@@ -1,2 +1,3 @@
 export { extractRailsId } from './extract-rails-id';
 export { createRailsId } from './create-rails-id';
+export { isExtractedRailsId } from './is-extracted-rails-id';

lib/index.js

@@ -1,2 +1,3 @@
 export { extractRailsId } from './extract-rails-id';
 export { createRailsId } from './create-rails-id';
+export { isExtractedRailsId } from './is-extracted-rails-id';

lib/is-extracted-rails-id.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks to see if the given string is a valid extracted Rails ID
+ * i.e. 55587 and not gid://qeepsake-rails/JournalEntry/55587
+ *
+ * @param id - rails ID
+ * @returns if ID is extracted rails ID
+ */
+export declare function isExtractedRailsId(id: string): boolean;

lib/is-extracted-rails-id.js

@@ -0,0 +1,14 @@
+/**
+ * Checks to see if the given string is a valid extracted Rails ID
+ * i.e. 55587 and not gid://qeepsake-rails/JournalEntry/55587
+ *
+ * @param id - rails ID
+ * @returns if ID is extracted rails ID
+ */
+export function isExtractedRailsId(id) {
+    if (typeof id === 'string') {
+        // Extracted IDs should NOT start with gid:// with no empty spaces
+        return !id.startsWith('gid://') && id.indexOf(' ') == -1;
+    }
+    return false;
+}

src/extract-rails-id.ts

@@ -1,3 +1,5 @@
+import { isExtractedRailsId } from './is-extracted-rails-id'
+
 /**
  * Extract rails ID
  *
@@ -18,6 +20,9 @@ export function extractRailsId(
   gid?: string | null,
   stripTimestamp = false,
 ): string | null {
+  // Checks if ID has already been extracted, if so, return it
+  if (gid && isExtractedRailsId(gid)) return gid
+
   if (typeof gid === 'string' && gid?.indexOf('/') != -1) {
     const gidComponents = gid.split('/')
     let extractedId = gidComponents[gidComponents.length - 1]

src/index.ts

@@ -1,2 +1,3 @@
 export { extractRailsId } from './extract-rails-id'
 export { createRailsId } from './create-rails-id'
+export { isExtractedRailsId } from './is-extracted-rails-id'

src/is-extracted-rails-id.ts

@@ -0,0 +1,15 @@
+/**
+ * Checks to see if the given string is a valid extracted Rails ID
+ * i.e. 55587 and not gid://qeepsake-rails/JournalEntry/55587
+ *
+ * @param id - rails ID
+ * @returns if ID is extracted rails ID
+ */
+export function isExtractedRailsId(id: string): boolean {
+  if (typeof id === 'string') {
+    // Extracted IDs should NOT start with gid:// with no empty spaces
+    return !id.startsWith('gid://') && id.indexOf(' ') == -1
+  }
+
+  return false
+}

tests/is-extracted-rails-id.test.js

@@ -0,0 +1,9 @@
+const { isExtractedRailsId } = require('../src/is-extracted-rails-id');
+
+test('Test non-extracted Rails ID equals false', () => {
+  expect(isExtractedRailsId('gid://qeepsake-rails/MyModel/12345')).toBe(false);
+});
+
+test('Test extracted Rails ID equals true', () => {
+    expect(isExtractedRailsId('12345')).toBe(true);
+});