@nymphjs/nymph 1.0.0-beta.98 → 1.0.0-beta.99

package/src/driver/NymphDriver.ts

@@ -2,6 +2,7 @@ import fs from 'node:fs';
 import { difference } from 'lodash-es';
 import ReadLines from 'n-readlines';
 import strtotime from 'locutus/php/datetime/strtotime.js';
+import { Tokenizer } from '@sciactive/tokenizer';
 
 import type Nymph from '../Nymph.js';
 import type { Selector, Options, FormattedSelector } from '../Nymph.types.js';
@@ -36,6 +37,8 @@ export default abstract class NymphDriver {
     },
   });
 
+  protected tokenizer = new Tokenizer();
+
   /**
    * A cache to make entity retrieval faster.
    */
@@ -87,13 +90,13 @@ export default abstract class NymphDriver {
    */
   abstract disconnect(): Promise<boolean>;
 
+  abstract needsMigration(): Promise<'json' | 'tokens' | false>;
+  abstract liveMigration(migrationType: 'tokenTables'): Promise<void>;
+
   /**
-   * Detect whether the database needs to be migrated.
-   *
-   * If true, the database should be exported with an old version of Nymph, then
-   * imported into a fresh database with this version.
+   * Returns a list of the etypes stored in the DB.
    */
-  abstract needsMigration(): Promise<boolean>;
+  abstract getEtypes(): Promise<string[]>;
 
   abstract exportDataIterator(): AsyncGenerator<
     { type: 'comment' | 'uid' | 'entity'; content: string },
@@ -131,6 +134,14 @@ export default abstract class NymphDriver {
     sdata: SerializedEntityData;
     etype: string;
   }): Promise<void>;
+  abstract importEntityTokens(entity: {
+    guid: string;
+    cdate: number;
+    mdate: number;
+    tags: string[];
+    sdata: SerializedEntityData;
+    etype: string;
+  }): Promise<void>;
   abstract importUID(uid: { name: string; value: number }): Promise<void>;
   abstract newUID(name: string): Promise<number | null>;
   abstract renameUID(oldName: string, newName: string): Promise<boolean>;
@@ -327,6 +338,7 @@ export default abstract class NymphDriver {
   }
 
   public checkData(
+    etype: string,
     data: EntityData,
     sdata: SerializedEntityData,
     selectors: Selector[],
@@ -334,6 +346,7 @@ export default abstract class NymphDriver {
     tags: string[] | null = null,
   ) {
     try {
+      const EntityClass = this.nymph.getEntityClassByEtype(etype);
       const formattedSelectors = this.formatSelectors(selectors).selectors;
 
       for (const curSelector of formattedSelectors) {
@@ -355,7 +368,7 @@ export default abstract class NymphDriver {
               Array.isArray(value) ? value : [value]
             ) as Selector[];
             pass = xor(
-              this.checkData(data, sdata, tmpArr, guid, tags),
+              this.checkData(etype, data, sdata, tmpArr, guid, tags),
               xor(typeIsNot, clauseNot),
             );
           } else {
@@ -499,6 +512,25 @@ export default abstract class NymphDriver {
                       xor(typeIsNot, clauseNot),
                     );
                     break;
+                  case 'search':
+                  case '!search':
+                    const testSearchValue = (
+                      curValue as [string, string]
+                    )[1] as string;
+                    const tokenString =
+                      propName in data
+                        ? (EntityClass.getFTSText(propName, data[propName]) ??
+                          '')
+                        : '';
+                    pass = xor(
+                      propName in data &&
+                        this.tokenizer.searchString(
+                          testSearchValue,
+                          tokenString,
+                        ),
+                      xor(typeIsNot, clauseNot),
+                    );
+                    break;
                   case 'gt':
                   case '!gt':
                     const testGTValue = (

package/src/driver/testArtifacts.ts

@@ -50,6 +50,7 @@ export function EntitiesTest(
       { nullbyte: '\\\x00\u0000  \x00' },
     ];
     testEntity.match = matchValue;
+    testEntity.search = searchValue;
     testEntity.number = 30;
     testEntity.numberString = '30';
     testEntity.timestamp = Date.now();
@@ -821,6 +822,180 @@ export function EntitiesTest(
     expect(testEntity.$inArray(resultEntity)).toEqual(true);
   });
 
+  it('basic search', async () => {
+    await createTestEntities();
+
+    // Retrieving entity by full text search...
+    let resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      {
+        type: '&',
+        tag: 'test',
+        search: [
+          'search',
+          'Declaration of the thirteen united States of America',
+        ],
+      }, // a substring
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+    resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      { type: '&', tag: 'test' },
+      {
+        type: '|',
+        search: [
+          ['string', 'pickle'],
+          ['search', 'Declaration of the thirteen united States of America'],
+        ],
+      }, // inclusive test
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+    resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      {
+        type: '&',
+        tag: 'test',
+        search: ['search', 'July 4, 1776'],
+      }, // a string with a number
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+  });
+
+  it('or search', async () => {
+    await createTestEntities();
+
+    // Retrieving entity by full text search...
+    let resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      {
+        type: '&',
+        tag: 'test',
+        search: ['search', 'Declaration or pickles'],
+      }, // a string with an or
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+  });
+
+  it('series search', async () => {
+    await createTestEntities();
+
+    // Retrieving entity by full text search...
+    let resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      {
+        type: '&',
+        tag: 'test',
+        search: ['search', '"excited domestic insurrections"'],
+      }, // double quoted substring
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+    resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      {
+        type: '&',
+        tag: 'test',
+        search: ['search', "'exciting domestic insurrected'"],
+      }, // single quoted substring
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+  });
+
+  it('negated search', async () => {
+    await createTestEntities();
+
+    // Retrieving entity by full text search...
+    let resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      {
+        type: '&',
+        tag: 'test',
+        search: ['search', '-pickle'],
+      }, // negated term
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+  });
+
+  it('combined search', async () => {
+    await createTestEntities();
+
+    // Retrieving entity by full text search...
+    let resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      {
+        type: '&',
+        tag: 'test',
+        search: ['search', 'Declaration -pickle'],
+      }, // negated term with positive term
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+    resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      {
+        type: '&',
+        tag: 'test',
+        search: ['search', 'Declaration "General Congress"'],
+      }, // terms found in separate areas
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+  });
+
+  it('wrong search', async () => {
+    await createTestEntities();
+
+    // Testing wrong search...
+    let resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      { type: '&', search: ['search', 'pickles'] },
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(false);
+    resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      { type: '&', tag: 'pickle', search: ['search', 'Declaration'] },
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(false);
+    resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      {
+        type: '|',
+        search: [
+          ['string', 'pickle'],
+          ['search', 'Hawaii'],
+        ],
+      },
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(false);
+  });
+
+  it('search must be case insensitive', async () => {
+    await createTestEntities();
+
+    // Retrieving entity by full text search...
+    const resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      {
+        type: '&',
+        tag: 'test',
+        search: [
+          'search',
+          'DECLARATION OF THE THIRTEEN UNITED STATES OF AMERICA',
+        ],
+      }, // a substring
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+  });
+
+  it('search and equal inclusive', async () => {
+    await createTestEntities();
+
+    // Retrieving entity by fts + equal inclusively...
+    const resultEntity = await nymph.getEntities(
+      { class: TestModel },
+      { type: '&', tag: 'test' },
+      { type: '|', equal: ['string', 'pickles'], search: ['string', 'test'] },
+    );
+    expect(testEntity.$inArray(resultEntity)).toEqual(true);
+  });
+
   it('greater than', async () => {
     await createTestEntities();
 
@@ -2259,6 +2434,55 @@ export function ExportImportTest(
 
     fs.unlinkSync(__dirname + '/testentityexport.nex');
   });
+
+  it('import tokens only', async () => {
+    const model = await nymph.getEntity({ class: TestModel });
+
+    expect(model).not.toBeNull();
+
+    if (model != null) {
+      const data = model.$getData(true);
+      // These should not actually be saved in the DB.
+      data.number = 424242424242;
+      // But this should become searchable.
+      data.search = 'peanuts and pickles on a hot bun';
+
+      const sdata = Object.fromEntries(
+        Object.entries(data).map(([name, value]) => [
+          name,
+          JSON.stringify(value),
+        ]),
+      );
+
+      if (model.guid == null || model.cdate == null || model.mdate == null) {
+        throw new Error('Model data is wrong.');
+      }
+
+      await nymph.importEntityTokens({
+        guid: model.guid,
+        // Again, these should not actually be changed in the DB.
+        cdate: model.cdate + 1000,
+        mdate: model.mdate + 1000,
+        tags: [...model.tags, 'helicopter'],
+        sdata,
+        etype: TestModel.ETYPE,
+      });
+
+      const modelCheck = await nymph.getEntity(
+        { class: TestModel },
+        { type: '&', search: ['search', '"peanuts and pickles on a hot bun"'] },
+      );
+
+      expect(modelCheck?.guid).toEqual(model.guid);
+      expect(modelCheck?.cdate).toEqual(model.cdate);
+      expect(modelCheck?.mdate).toEqual(model.mdate);
+      expect(modelCheck?.$hasTag('helicopter')).toEqual(false);
+      expect(modelCheck?.number).not.toEqual(424242424242);
+      expect(modelCheck?.search).not.toEqual(
+        'peanuts and pickles on a hot bun',
+      );
+    }
+  });
 }
 
 const matchValue = `Hello, my name is Edward McCheese. It is a pleasure to meet you. As you can see, I have several hats of the most pleasant nature.
@@ -2371,3 +2595,69 @@ Cursus velit lacus aenean elit conubia. Velit in inceptos enim, elit lobortis es
 Pellentesque quis dignissim euismod in fermentum quam lobortis porta. Dis euismod ultricies montes odio sapien condimentum integer per. Torquent nascetur ante ante; diam ultrices nec habitant. Augue congue a conubia commodo ultricies tortor. Quis ridiculus netus vivamus dictumst efficitur parturient hendrerit. Facilisis ultrices suspendisse elit sodales eleifend maecenas tempor. Habitasse platea congue ac, pretium augue odio interdum netus. Mattis odio mi leo integer nisi diam phasellus elementum. Tortor himenaeos curabitur enim sit ac mi dictumst faucibus sociosqu.
 
 Duis ex viverra auctor praesent elit ac. Sit ex at cubilia aenean scelerisque finibus ridiculus. Hendrerit imperdiet potenti erat risus commodo. Sit donec ullamcorper facilisi neque varius, suscipit malesuada hac. Nulla lacinia pulvinar non volutpat pellentesque lobortis ultrices dis. Faucibus luctus fusce, aliquam magnis pharetra sed dui nulla viverra. Lectus hendrerit eu pellentesque nostra mauris suspendisse himenaeos. Lectus bibendum inceptos commodo nulla magnis proin.`;
+
+const searchValue = `In Congress, July 4, 1776
+
+The unanimous Declaration of the thirteen united States of America, When in the Course of human events, it becomes necessary for one people to dissolve the political bands which have connected them with another, and to assume among the powers of the earth, the separate and equal station to which the Laws of Nature and of Nature's God entitle them, a decent respect to the opinions of mankind requires that they should declare the causes which impel them to the separation.
+
+We hold these truths to be self-evident, that all men are created equal, that they are endowed by their Creator with certain unalienable Rights, that among these are Life, Liberty and the pursuit of Happiness.--That to secure these rights, Governments are instituted among Men, deriving their just powers from the consent of the governed, --That whenever any Form of Government becomes destructive of these ends, it is the Right of the People to alter or to abolish it, and to institute new Government, laying its foundation on such principles and organizing its powers in such form, as to them shall seem most likely to effect their Safety and Happiness. Prudence, indeed, will dictate that Governments long established should not be changed for light and transient causes; and accordingly all experience hath shewn, that mankind are more disposed to suffer, while evils are sufferable, than to right themselves by abolishing the forms to which they are accustomed. But when a long train of abuses and usurpations, pursuing invariably the same Object evinces a design to reduce them under absolute Despotism, it is their right, it is their duty, to throw off such Government, and to provide new Guards for their future security.--Such has been the patient sufferance of these Colonies; and such is now the necessity which constrains them to alter their former Systems of Government. The history of the present King of Great Britain is a history of repeated injuries and usurpations, all having in direct object the establishment of an absolute Tyranny over these States. To prove this, let Facts be submitted to a candid world.
+
+He has refused his Assent to Laws, the most wholesome and necessary for the public good.
+
+He has forbidden his Governors to pass Laws of immediate and pressing importance, unless suspended in their operation till his Assent should be obtained; and when so suspended, he has utterly neglected to attend to them.
+
+He has refused to pass other Laws for the accommodation of large districts of people, unless those people would relinquish the right of Representation in the Legislature, a right inestimable to them and formidable to tyrants only.
+
+He has called together legislative bodies at places unusual, uncomfortable, and distant from the depository of their public Records, for the sole purpose of fatiguing them into compliance with his measures.
+
+He has dissolved Representative Houses repeatedly, for opposing with manly firmness his invasions on the rights of the people.
+
+He has refused for a long time, after such dissolutions, to cause others to be elected; whereby the Legislative powers, incapable of Annihilation, have returned to the People at large for their exercise; the State remaining in the mean time exposed to all the dangers of invasion from without, and convulsions within.
+
+He has endeavoured to prevent the population of these States; for that purpose obstructing the Laws for Naturalization of Foreigners; refusing to pass others to encourage their migrations hither, and raising the conditions of new Appropriations of Lands.
+
+He has obstructed the Administration of Justice, by refusing his Assent to Laws for establishing Judiciary powers.
+
+He has made Judges dependent on his Will alone, for the tenure of their offices, and the amount and payment of their salaries.
+
+He has erected a multitude of New Offices, and sent hither swarms of Officers to harrass our people, and eat out their substance.
+
+He has kept among us, in times of peace, Standing Armies without the Consent of our legislatures.
+
+He has affected to render the Military independent of and superior to the Civil power.
+
+He has combined with others to subject us to a jurisdiction foreign to our constitution, and unacknowledged by our laws; giving his Assent to their Acts of pretended Legislation:
+
+For Quartering large bodies of armed troops among us:
+
+For protecting them, by a mock Trial, from punishment for any Murders which they should commit on the Inhabitants of these States:
+
+For cutting off our Trade with all parts of the world:
+
+For imposing Taxes on us without our Consent:
+
+For depriving us in many cases, of the benefits of Trial by Jury:
+
+For transporting us beyond Seas to be tried for pretended offences:
+
+For abolishing the free System of English Laws in a neighbouring Province, establishing therein an Arbitrary government, and enlarging its Boundaries so as to render it at once an example and fit instrument for introducing the same absolute rule into these Colonies:
+
+For taking away our Charters, abolishing our most valuable Laws, and altering fundamentally the Forms of our Governments:
+
+For suspending our own Legislatures, and declaring themselves invested with power to legislate for us in all cases whatsoever.
+
+He has abdicated Government here, by declaring us out of his Protection and waging War against us.
+
+He has plundered our seas, ravaged our Coasts, burnt our towns, and destroyed the lives of our people.
+
+He is at this time transporting large Armies of foreign Mercenaries to compleat the works of death, desolation and tyranny, already begun with circumstances of Cruelty & perfidy scarcely paralleled in the most barbarous ages, and totally unworthy the Head of a civilized nation.
+
+He has constrained our fellow Citizens taken Captive on the high Seas to bear Arms against their Country, to become the executioners of their friends and Brethren, or to fall themselves by their Hands.
+
+He has excited domestic insurrections amongst us, and has endeavoured to bring on the inhabitants of our frontiers, the merciless Indian Savages, whose known rule of warfare, is an undistinguished destruction of all ages, sexes and conditions.
+
+In every stage of these Oppressions We have Petitioned for Redress in the most humble terms: Our repeated Petitions have been answered only by repeated injury. A Prince, whose character is thus marked by every act which may define a Tyrant, is unfit to be the ruler of a free people.
+
+Nor have We been wanting in attentions to our Brittish brethren. We have warned them from time to time of attempts by their legislature to extend an unwarrantable jurisdiction over us. We have reminded them of the circumstances of our emigration and settlement here. We have appealed to their native justice and magnanimity, and we have conjured them by the ties of our common kindred to disavow these usurpations, which, would inevitably interrupt our connections and correspondence. They too have been deaf to the voice of justice and of consanguinity. We must, therefore, acquiesce in the necessity, which denounces our Separation, and hold them, as we hold the rest of mankind, Enemies in War, in Peace Friends.
+
+We, therefore, the Representatives of the united States of America, in General Congress, Assembled, appealing to the Supreme Judge of the world for the rectitude of our intentions, do, in the Name, and by Authority of the good People of these Colonies, solemnly publish and declare, That these United Colonies are, and of Right ought to be Free and Independent States; that they are Absolved from all Allegiance to the British Crown, and that all political connection between them and the State of Great Britain, is and ought to be totally dissolved; and that as Free and Independent States, they have full Power to levy War, conclude Peace, contract Alliances, establish Commerce, and to do all other Acts and Things which Independent States may of right do. And for the support of this Declaration, with a firm reliance on the protection of divine Providence, we mutually pledge to each other our Lives, our Fortunes and our sacred Honor.`;

package/src/testArtifacts.ts

@@ -7,6 +7,7 @@ export type TestModelData = {
   test?: string;
   array?: any[];
   match?: string;
+  search?: string;
   number?: number;
   numberString?: string;
   timestamp?: Number;