@afora/core 0.0.4 → 0.0.6

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 export { applicationOf, isApplication } from "./core/application/application.js";
-export { ApplicationAlreadyStarted, ApplicationConflict, ApplicationNotStarted, DuplicateApplicationDeclaration, InvalidApplicationDeclaration, InvalidApplicationEnvironment, UnregisteredApplicationReference, UnregisteredRepositoryDependency, UnregisteredUseCaseDependency, } from "./core/application/exceptions.js";
+export { ApplicationAlreadyStarted, ApplicationConflict, ApplicationNotStarted, DuplicateApplicationDeclaration, InvalidApplicationDeclaration, InvalidApplicationEnvironment, ProviderNotBound, UnregisteredApplicationReference, UnregisteredRepositoryDependency, UnregisteredUseCaseDependency, } from "./core/application/exceptions.js";
+export { isProviderSlot, isProviderStorage, type ProviderSlot, type ProviderStorage, providersOf, } from "./core/application/providers.js";
 export { type Register, type RegisteredApplication, resetApplication, useApplication, } from "./core/application/registry.js";
 export { isLogFactory, isProviderFactory, type LogFactory, logFrom, type ProviderFactory, providerFrom, } from "./core/application/start.js";
-export type { AnyApplication, ApplicationCollections, ApplicationContext, ApplicationDescription, ApplicationSettings, ApplicationStartOptions, CommandDescription, ExceptionDescription, FieldDescription, FieldsDescription, IApplication, LogDescription, OutputDescription, PropertyDescription, PropertyLineageDescription, PropertyReference, RecordDescription, UseCaseDependencyDescription, UseCaseDescription, } from "./core/application/types/application.interface.js";
+export type { AnyApplication, ApplicationCollections, ApplicationContext, ApplicationDescription, ApplicationRunArgs, ApplicationRunOptions, ApplicationSettings, ApplicationStartOptions, CommandDescription, ExceptionDescription, FieldDescription, FieldsDescription, IApplication, LogDescription, OutputDescription, PropertyDescription, PropertyLineageDescription, PropertyReference, ProviderReference, RecordDescription, UseCaseDependencyDescription, UseCaseDescription, } from "./core/application/types/application.interface.js";
 export { blueprintBuilderOf } from "./core/blueprint/blueprint.js";
 export { blueprintPluginOf } from "./core/blueprint/blueprint-plugin.js";
 export { ReservedBlueprintKey, UndeclaredBlueprintProperty, } from "./core/blueprint/exceptions.js";
@@ -61,22 +62,23 @@ export type { IProperty } from "./core/property/types/property.interface.js";
 export type { AnyPropertyConstructor, IPropertyCollection, } from "./core/property/types/property-collection.type.js";
 export type { PropertyValue } from "./core/property/types/property-constructor.type.js";
 export type { CallableProperty, NumberConstraints, PropertyMetadata, PropertyOptions, StringConstraints, } from "./core/property/types/property-options.interface.js";
-export type { IPropertyType, UniqueMark, } from "./core/property/types/property-type.interface.js";
+export type { IPropertyType, SensitiveMark, UniqueMark, } from "./core/property/types/property-type.interface.js";
 export { AbstractRecord, RESERVED_RECORD_KEYS, } from "./core/record/abstract-record.js";
-export { IncompatibleRecordPlugin, InvalidRecordPlugin, InvalidRecordValue, RecordPluginConflict, ReservedRecordKey, UndeclaredRecordProperty, UnknownRecordPlugin, } from "./core/record/exceptions.js";
+export { IncompatibleRecordPlugin, InvalidRecordDeclaration, InvalidRecordPlugin, InvalidRecordValue, RecordPluginConflict, ReservedRecordKey, UndeclaredRecordProperty, UnknownRecordPlugin, } from "./core/record/exceptions.js";
 export { MASK } from "./core/record/mask.js";
+export { recordNameOf } from "./core/record/name.js";
 export { hasPlugin, isRecordPlugin, pluginsOf, recordPluginOf, } from "./core/record/plugin.js";
 export { recordPluginCatalogOf } from "./core/record/plugin-catalog.js";
 export type { RecordBuilder } from "./core/record/record.js";
 export { recordBuilderOf } from "./core/record/record.js";
 export type { AnyRecordPlugin, IRecordPlugin, IRecordPluginCatalog, PluginUniqueKey, RecordPluginDescriptor, RecordPluginOptions, RecordPluginReference, RecordPluginRequirement, RecordPluginsOption, } from "./core/record/types/plugin.interface.js";
-export type { DeclaredRecordInstance, IRecord, MarkedUniqueKey, RecordChange, RecordChanges, RecordConstructor, RecordEffect, RecordEffects, RecordKey, RecordOptions, RecordSettings, RecordValue, } from "./core/record/types/record.interface.js";
-export { InvalidRepositoryData, InvalidRepositoryDeclaration, InvalidRepositoryEntity, InvalidRepositoryQuery, RepositoryEntityNotFound, RepositoryUniqueViolation, } from "./core/repository/exceptions.js";
+export type { DeclaredRecordInstance, IRecord, MarkedUniqueKey, Masked, RecordChange, RecordChanges, RecordConstructor, RecordEffect, RecordEffects, RecordJson, RecordKey, RecordOptions, RecordSettings, RecordValue, } from "./core/record/types/record.interface.js";
+export { InvalidRepositoryCursor, InvalidRepositoryData, InvalidRepositoryDeclaration, InvalidRepositoryEntity, InvalidRepositoryQuery, RepositoryEntityNotFound, RepositoryUniqueViolation, } from "./core/repository/exceptions.js";
 export { inMemoryProvider } from "./core/repository/in-memory.js";
 export { providerDescriptionOf, providerOf } from "./core/repository/provider.js";
 export type { RepositorySettings } from "./core/repository/repository.js";
 export { AbstractRepository, isRepository, RepositoryOf, repositoryOf, } from "./core/repository/repository.js";
-export type { ProviderCapabilities, ProviderDescription, ProviderOption, ProviderOptions, ProviderSettings, RepositoryExists, RepositoryFindMany, RepositoryFindPage, RepositoryOrder, RepositoryPage, RepositoryQuery, RepositoryWhere, } from "./core/repository/types/query.interface.js";
+export type { ProviderCapabilities, ProviderDescription, ProviderOption, ProviderOptions, ProviderQuery, ProviderSettings, RepositoryCursorPage, RepositoryCursorQuery, RepositoryExists, RepositoryFindCursor, RepositoryFindMany, RepositoryFindPage, RepositoryOrder, RepositoryPage, RepositoryQuery, RepositoryWhere, } from "./core/repository/types/query.interface.js";
 export type { AnyRepository, AnyRepositoryEntity, EntityInstanceOf, EntityKeyOf, EntityNonUniqueKeyOf, EntityUniqueKeyOf, EntityValueOf, IRepositoryProvider, QueryValueOf, RepositoryAction, RepositoryContext, RepositoryCount, RepositoryCreate, RepositoryCreateInput, RepositoryData, RepositoryDelete, RepositoryFindBy, RepositoryFindManyBy, RepositoryUpdate, } from "./core/repository/types/repository.interface.js";
 export type { SchemaClass } from "./core/schema/schema.js";
 export { schemaOf } from "./core/schema/schema.js";

package/dist/index.js

@@ -10,6 +10,7 @@ import {
   UnregisteredRepositoryDependency2,
   UnregisteredUseCaseDependency2,
   ApplicationNotStarted2,
+  ProviderNotBound2,
   ApplicationAlreadyStarted2,
   InvalidApplicationEnvironment2,
   useApplication2,
@@ -33,6 +34,7 @@ import {
   EntityUniqueKeys2,
   AbstractEntity2,
   InvalidRepositoryQuery2,
+  InvalidRepositoryCursor2,
   InvalidRepositoryDeclaration2,
   InvalidRepositoryEntity2,
   InvalidRepositoryData2,
@@ -76,6 +78,9 @@ import {
   logFrom2,
   isLogFactory2,
   isProviderFactory2,
+  providersOf2,
+  isProviderSlot2,
+  isProviderStorage2,
   isApplication2,
   applicationOf2,
   blueprintPluginOf2,
@@ -127,7 +132,7 @@ import {
   entityOf2,
   recordOf2,
   StdStages2
-} from "./index-ewm6r4nw.js";
+} from "./index-gbgc40xe.js";
 import {
   isProperty2,
   schemaOf2,
@@ -138,6 +143,7 @@ import {
   isRecordClass2,
   isOptionalRecord2,
   recordFieldOf2,
+  recordNameOf2,
   listOf2,
   isBlueprintList2,
   ExceptionLayers2,
@@ -146,6 +152,7 @@ import {
   exceptionOf2,
   Meta2,
   InvalidRecordValue2,
+  InvalidRecordDeclaration2,
   UndeclaredRecordProperty2,
   ReservedRecordKey2,
   InvalidRecordPlugin2,
@@ -171,7 +178,7 @@ import {
   propertyOf2,
   optionalOf2,
   blueprintBuilderOf2
-} from "./index-hn82hm31.js";
+} from "./index-3nd9bjnc.js";
 export {
   AbstractDefineProperty2 as AbstractDefineProperty,
   AbstractEntity2 as AbstractEntity,
@@ -213,8 +220,10 @@ export {
   InvalidOpenAPIModel2 as InvalidOpenAPIModel,
   InvalidOutputStage2 as InvalidOutputStage,
   InvalidPropertyValue2 as InvalidPropertyValue,
+  InvalidRecordDeclaration2 as InvalidRecordDeclaration,
   InvalidRecordPlugin2 as InvalidRecordPlugin,
   InvalidRecordValue2 as InvalidRecordValue,
+  InvalidRepositoryCursor2 as InvalidRepositoryCursor,
   InvalidRepositoryData2 as InvalidRepositoryData,
   InvalidRepositoryDeclaration2 as InvalidRepositoryDeclaration,
   InvalidRepositoryEntity2 as InvalidRepositoryEntity,
@@ -239,6 +248,7 @@ export {
   Phone2 as Phone,
   PropertyRequired2 as PropertyRequired,
   PropertyStates2 as PropertyStates,
+  ProviderNotBound2 as ProviderNotBound,
   Publishable2 as Publishable,
   RESERVED_ENTITY_KEYS2 as RESERVED_ENTITY_KEYS,
   RESERVED_RECORD_KEYS2 as RESERVED_RECORD_KEYS,
@@ -299,6 +309,8 @@ export {
   isPasswordHash2 as isPasswordHash,
   isProperty2 as isProperty,
   isProviderFactory2 as isProviderFactory,
+  isProviderSlot2 as isProviderSlot,
+  isProviderStorage2 as isProviderStorage,
   isRecordClass2 as isRecordClass,
   isRecordPlugin2 as isRecordPlugin,
   isRepository2 as isRepository,
@@ -323,8 +335,10 @@ export {
   providerDescriptionOf2 as providerDescriptionOf,
   providerFrom2 as providerFrom,
   providerOf2 as providerOf,
+  providersOf2 as providersOf,
   recordBuilderOf2 as recordBuilderOf,
   recordFieldOf2 as recordFieldOf,
+  recordNameOf2 as recordNameOf,
   recordOf2 as recordOf,
   recordPluginCatalogOf2 as recordPluginCatalogOf,
   recordPluginOf2 as recordPluginOf,

package/dist/std/properties/password.d.ts

@@ -5,7 +5,11 @@ export declare const PASSWORD_SPECIAL_CHARACTERS = "!@#$%^&*()-_=+[]{}|\\;:'\",.
 export declare function isPasswordHash(value: string): boolean;
 /** The rules a plain password breaks; empty when it is strong enough. */
 export declare function passwordIssues(value: string): string[];
-declare const Password_base: import("../../index.js").PropertyClass<Type.TString, string>;
+declare const Password_base: import("../../index.js").PropertyClass<Type.TString, string> & {
+    readonly type: {
+        readonly sensitive: true;
+    };
+};
 /**
  * A password stored as an Argon2 hash. The constructor only accepts a hash,
  * e.g. one read from the database; `Password.hash` turns a plain password

package/dist/std/record-plugins.d.ts

@@ -6,7 +6,7 @@ declare const PublishableRecord_base: import("../index.js").RecordConstructor<im
         safeParse(value: unknown): import("../index.js").ParseResult<string | undefined>;
         readonly "~standard": import("../index.js").StandardSchemaV1.Props<string | undefined, string | undefined>;
     }>;
-}>, [], never, unknown>;
+}>, [], never, unknown, never, never>;
 /**
  * A `publishedAt` absent while the record is a draft; `publish(at?)` sets it
  * (to now by default), `unpublish()` clears it, `isPublished` tells.
@@ -30,7 +30,7 @@ declare const ArchivableRecord_base: import("../index.js").RecordConstructor<imp
         safeParse(value: unknown): import("../index.js").ParseResult<string | undefined>;
         readonly "~standard": import("../index.js").StandardSchemaV1.Props<string | undefined, string | undefined>;
     }>;
-}>, [], never, unknown>;
+}>, [], never, unknown, never, never>;
 /**
  * An `archivedAt` absent while the record is active; `archive(at?)` sets it,
  * `restore()` clears it, `isArchived` tells.
@@ -49,7 +49,7 @@ export declare class ArchivableRecord extends ArchivableRecord_base {
 export declare const Archivable: import("../index.js").IRecordPlugin<typeof ArchivableRecord, "archivable">;
 declare const TaggableRecord_base: import("../index.js").RecordConstructor<import("../core/property/types/property-options.interface.js").StoredFields<{
     tags: import("../index.js").IBlueprintList<import("../index.js").PropertyClass<import("typebox").TString, string>, true>;
-}>, [], never, unknown>;
+}>, [], never, unknown, never, never>;
 /**
  * `tags`, a list of strings, each once; `tag`, `untag` and `hasTag` change and read it.
  *
@@ -67,7 +67,7 @@ export declare class TaggableRecord extends TaggableRecord_base {
 export declare const Taggable: import("../index.js").IRecordPlugin<typeof TaggableRecord, "taggable">;
 declare const OwnableRecord_base: import("../index.js").RecordConstructor<import("../core/property/types/property-options.interface.js").StoredFields<{
     ownerId: import("../index.js").CallableProperty<typeof import("../index.js").Id>;
-}>, [], never, unknown>;
+}>, [], never, unknown, never, never>;
 /**
  * An `ownerId`, the id of who owns the record, with `isOwnedBy` and `transferTo`.
  *
@@ -84,7 +84,7 @@ export declare const Ownable: import("../index.js").IRecordPlugin<typeof Ownable
 declare const AuthenticatableRecord_base: import("../index.js").RecordConstructor<import("../core/property/types/property-options.interface.js").StoredFields<{
     email: import("../index.js").CallableProperty<import("../index.js").PropertyClass<import("typebox").TString, string>>;
     password: import("../index.js").CallableProperty<typeof Password>;
-}>, readonly ["password"], "email", unknown>;
+}>, readonly ["password"], "email", unknown, never, never>;
 /**
  * An `email`, unique, and a `password` hash, sensitive, changed by
  * `change.password` and checked by `verifyPassword`.

package/dist/testing/index.js

@@ -1,10 +1,10 @@
-import"../index-hn82hm31.js";
+import"../index-3nd9bjnc.js";
 import {
   RepositoryUniqueViolation2,
   RepositoryEntityNotFound2,
   blueprintOf2,
   entityOf2
-} from "../index-ewm6r4nw.js";
+} from "../index-gbgc40xe.js";
 
 // src/testing/provider-contract.ts
 function contextOf(name = "Accounts") {
@@ -371,6 +371,95 @@ function providerContract(runner, makeProvider, options = {}) {
         expect(stored).toEqual(data);
       });
     });
+    describe("keyset", () => {
+      const keyset = (name, body) => it(name, async () => {
+        const enabled = options.keyset ?? (await makeProvider()).capabilities?.keyset;
+        if (enabled === true)
+          await body();
+      });
+      const seeded = async () => {
+        const f = await fixture();
+        const [a, b, c, d, e, g] = [
+          row({ n: 1, group: 1, name: "Gil" }),
+          row({ group: 1, name: "Érico" }),
+          row({ n: 2, group: 2, name: "Ana" }),
+          row({ n: 2, group: 1, name: "ana" }),
+          row({ group: 2, name: "Bia" }),
+          row({ n: 3, group: 2, name: "Zoe" })
+        ];
+        await f.seed(a, b, c, d, e, g);
+        const find = (query) => f.provider.findMany(f.context, query).then(ids);
+        return { ...f, a, b, c, d, e, g, find };
+      };
+      const by = (key, direction = "asc") => [{ key, direction }, { key: "id" }];
+      keyset("gives the rows strictly after the position, ascending", async () => {
+        const { find, a, c, d, g } = await seeded();
+        const orderBy = by("n");
+        expect(await find({ orderBy, after: [1, a.id] })).toEqual([
+          c.id,
+          d.id,
+          g.id
+        ]);
+        expect(await find({ orderBy, after: [2, c.id] })).toEqual([
+          d.id,
+          g.id
+        ]);
+        expect(await find({ orderBy, after: [3, g.id] })).toEqual([]);
+      });
+      keyset("follows a descending order", async () => {
+        const { find, a, c, d, g } = await seeded();
+        const orderBy = by("n", "desc");
+        expect(await find({
+          orderBy,
+          after: [3, g.id],
+          where: { n: { in: [1, 2] } }
+        })).toEqual([c.id, d.id, a.id]);
+        expect(await find({
+          orderBy,
+          after: [2, d.id],
+          where: { n: { in: [1, 2] } }
+        })).toEqual([a.id]);
+      });
+      keyset("missing values are first ascending and last descending", async () => {
+        const { find, a, b, c, d, e, g } = await seeded();
+        expect(await find({ orderBy: by("n"), after: [undefined, b.id] })).toEqual([e.id, a.id, c.id, d.id, g.id]);
+        expect(await find({ orderBy: by("n"), after: [undefined, e.id] })).toEqual([a.id, c.id, d.id, g.id]);
+        expect(await find({ orderBy: by("n", "desc"), after: [1, a.id] })).toEqual([b.id, e.id]);
+        expect(await find({ orderBy: by("n", "desc"), after: [undefined, b.id] })).toEqual([e.id]);
+        expect(await find({ orderBy: by("n", "desc"), after: [undefined, e.id] })).toEqual([]);
+      });
+      keyset("compares strings by code point", async () => {
+        const { find, a, b, c, d, e, g } = await seeded();
+        expect(await find({ orderBy: by("name"), after: ["Bia", e.id] })).toEqual([a.id, g.id, d.id, b.id]);
+        expect(await find({ orderBy: by("name", "desc"), after: ["ana", d.id] })).toEqual([g.id, a.id, e.id, c.id]);
+      });
+      keyset("combines with where, withDeleted and limit; count ignores it", async () => {
+        const { provider, context, find, a, b, d } = await seeded();
+        const orderBy = [{ key: "id" }];
+        expect(await find({
+          orderBy,
+          after: [a.id],
+          where: { group: 1 },
+          limit: 1
+        })).toEqual([b.id]);
+        expect(await find({ orderBy, after: [b.id], where: { group: 1 } })).toEqual([d.id]);
+        await provider.update(context, {
+          ...d,
+          deletedAt: "2024-01-01T00:00:00.000Z"
+        });
+        expect(await find({ orderBy, after: [b.id], where: { group: 1 } })).toEqual([]);
+        expect(await find({
+          orderBy,
+          after: [b.id],
+          where: { group: 1 },
+          withDeleted: true
+        })).toEqual([d.id]);
+        expect(await provider.count(context, {
+          orderBy,
+          after: [b.id]
+        })).toBe(5);
+      });
+    });
     const withTransactions = async () => {
       const enabled = options.transactions ?? (await makeProvider()).capabilities?.transactions;
       return enabled === true;

package/dist/testing/provider-contract.d.ts

@@ -13,6 +13,11 @@ export interface ProviderContractOptions {
      * Run the transaction cases. Defaults to `provider.capabilities?.transactions`.
      */
     readonly transactions?: boolean;
+    /**
+     * Run the cases of `after`, which `findCursor` gives to `findMany`. Defaults
+     * to `provider.capabilities?.keyset`.
+     */
+    readonly keyset?: boolean;
 }
 /**
  * Registers the behavior every `IRepositoryProvider` v2 must have. Pass the

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@afora/core",
-	"version": "0.0.4",
+	"version": "0.0.6",
 	"description": "Domain modeling on TypeBox: entities with invariants, repositories, use cases, sensitive data masking and layered exceptions, usable by any Standard Schema consumer.",
 	"keywords": [
 		"domain-driven-design",