joist-core 2.3.0 → 2.4.0

package/build/Entity.d.mts

@@ -0,0 +1,42 @@
+import { EntityManager, TaggedId } from "./EntityManager.mjs";
+//#region src/Entity.d.ts
+declare function isEntity(maybeEntity: unknown): maybeEntity is Entity;
+/** All the types we support for entity `id` fields. */
+type IdType = number | string;
+/** A marker/base interface for all of our entity types. */
+interface Entity {
+  /** The entity id, either tagged or untagged; the per-application `Entity` will specialize appropriately. */
+  id: IdType;
+  idMaybe: IdType | undefined;
+  /** The entity id that is always tagged, regardless of the idType config. */
+  idTagged: TaggedId;
+  idTaggedMaybe: TaggedId | undefined;
+  readonly em: EntityManager;
+  readonly isNewEntity: boolean;
+  readonly isDeletedEntity: boolean;
+  readonly isDirtyEntity: boolean;
+  readonly transientFields: Record<string, unknown>;
+  set(opts: unknown): void;
+  setPartial(opts: unknown): void;
+  setDeepPartial(opts: unknown): Promise<void>;
+  /**
+   * Returns `type:id`, i.e. `Author:1` for persisted entities and `Author#1` for new entities.
+   *
+   * Once an entity is persisted, we'll return `Author#1:1` to denote "the previously-new author #1
+   * is now authors row id=1 in the database".
+   *
+   * This is meant to be used for developer-facing logging and debugging, and not a user-facing
+   * name / display name.
+   */
+  toString(): string;
+  /**
+   * Returns `tag:id`, i.e. `a:1` for persisted entities and `a#1` for new entities.
+   *
+   * This is meant to be used for developer-facing logging and debugging, and not a user-facing
+   * name / display name.
+   */
+  toTaggedString(): string;
+}
+//#endregion
+export { Entity, IdType, isEntity };
+//# sourceMappingURL=Entity.d.mts.map

package/build/Entity.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.d.mts","names":[],"sources":["../src/Entity.ts"],"mappings":";;iBAGgB,SAAS,uBAAuB,eAAe;;KAKnD;;UAGK;;EAEf,IAAI;EACJ,SAAS;;EAET,UAAU;EACV,eAAe;WACN,IAAI;WACJ;WACA;WACA;WACA,iBAAiB;EAC1B,IAAI;EACJ,WAAW;EACX,eAAe,gBAAgB;;;;;;;;;;EAU/B;;;;;;;EAOA"}

package/build/Entity.js

@@ -1,8 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isEntity = isEntity;
-const index_1 = require("./index");
+import "./index.js";
+import "./EntityManager.js";
+import { BaseEntity } from "./BaseEntity.js";
+//#region src/Entity.ts
 function isEntity(maybeEntity) {
-    return maybeEntity instanceof index_1.BaseEntity;
+	return maybeEntity instanceof BaseEntity;
 }
+//#endregion
+export { isEntity };
+
 //# sourceMappingURL=Entity.js.map

package/build/Entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../src/Entity.ts"],"names":[],"mappings":";;AAGA,4BAEC;AAJD,mCAAqC;AAErC,SAAgB,QAAQ,CAAC,WAAoB;IAC3C,OAAO,WAAW,YAAY,kBAAU,CAAC;AAC3C,CAAC"}
+{"version":3,"file":"Entity.js","names":[],"sources":["../src/Entity.ts"],"sourcesContent":["import { type EntityManager, type TaggedId } from \"src/EntityManager.ts\";\nimport { BaseEntity } from \"src/index.ts\";\n\nexport function isEntity(maybeEntity: unknown): maybeEntity is Entity {\n  return maybeEntity instanceof BaseEntity;\n}\n\n/** All the types we support for entity `id` fields. */\nexport type IdType = number | string;\n\n/** A marker/base interface for all of our entity types. */\nexport interface Entity {\n  /** The entity id, either tagged or untagged; the per-application `Entity` will specialize appropriately. */\n  id: IdType;\n  idMaybe: IdType | undefined;\n  /** The entity id that is always tagged, regardless of the idType config. */\n  idTagged: TaggedId;\n  idTaggedMaybe: TaggedId | undefined;\n  readonly em: EntityManager;\n  readonly isNewEntity: boolean;\n  readonly isDeletedEntity: boolean;\n  readonly isDirtyEntity: boolean;\n  readonly transientFields: Record<string, unknown>;\n  set(opts: unknown): void;\n  setPartial(opts: unknown): void;\n  setDeepPartial(opts: unknown): Promise<void>;\n  /**\n   * Returns `type:id`, i.e. `Author:1` for persisted entities and `Author#1` for new entities.\n   *\n   * Once an entity is persisted, we'll return `Author#1:1` to denote \"the previously-new author #1\n   * is now authors row id=1 in the database\".\n   *\n   * This is meant to be used for developer-facing logging and debugging, and not a user-facing\n   * name / display name.\n   */\n  toString(): string;\n  /**\n   * Returns `tag:id`, i.e. `a:1` for persisted entities and `a#1` for new entities.\n   *\n   * This is meant to be used for developer-facing logging and debugging, and not a user-facing\n   * name / display name.\n   */\n  toTaggedString(): string;\n}\n"],"mappings":";;;;AAGA,SAAgB,SAAS,aAA6C;CACpE,OAAO,uBAAuB;AAChC"}

package/build/EntityFields.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });

package/build/EntityFields.d.cts

@@ -0,0 +1,36 @@
+//#region src/EntityFields.d.ts
+/** All the fields for an entity in the `FieldsOf` / `EntityField` format. */
+type EntityFields<T> = { [K in keyof T]: EntityField; };
+type EntityField = {
+  kind: "primitive";
+  type: unknown;
+  unique: boolean;
+  nullable: never | undefined;
+  derived: boolean;
+} | {
+  kind: "enum";
+  type: unknown;
+  nullable: never | unknown;
+} | {
+  kind: "m2o";
+  type: unknown;
+  nullable: never | unknown;
+  derived: boolean;
+} | {
+  kind: "poly";
+  type: unknown;
+  nullable: never | unknown;
+};
+/** The subset of primitive, enum, and m2o fields from the `F` that are settable, i.e. not derived. */
+type SettableFields<F> = { [K in keyof F]: F[K] extends {
+  kind: "primitive";
+  derived: false;
+} ? F[K] : F[K] extends {
+  kind: "enum";
+} ? F[K] : F[K] extends {
+  kind: "m2o";
+  derived: false;
+} ? F[K] : never; };
+//#endregion
+export { EntityField, EntityFields, SettableFields };
+//# sourceMappingURL=EntityFields.d.cts.map

package/build/EntityFields.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityFields.d.cts","names":[],"sources":["../src/EntityFields.ts"],"mappings":";;KACY,aAAa,QACtB,WAAW,IAAI;KAGN;EACN;EAAmB;EAAe;EAAiB;EAA6B;;EAChF;EAAc;EAAe;;EAC7B;EAAa;EAAe;EAA2B;;EACvD;EAAc;EAAe;;;KAGvB,eAAe,QACxB,WAAW,IAAI,EAAE;EAAa;EAAmB;IAC9C,EAAE,KACF,EAAE;EAAa;IACb,EAAE,KACF,EAAE;EAAa;EAAa;IAC1B,EAAE"}

package/build/EntityFields.d.mts

@@ -0,0 +1,36 @@
+//#region src/EntityFields.d.ts
+/** All the fields for an entity in the `FieldsOf` / `EntityField` format. */
+type EntityFields<T> = { [K in keyof T]: EntityField; };
+type EntityField = {
+  kind: "primitive";
+  type: unknown;
+  unique: boolean;
+  nullable: never | undefined;
+  derived: boolean;
+} | {
+  kind: "enum";
+  type: unknown;
+  nullable: never | unknown;
+} | {
+  kind: "m2o";
+  type: unknown;
+  nullable: never | unknown;
+  derived: boolean;
+} | {
+  kind: "poly";
+  type: unknown;
+  nullable: never | unknown;
+};
+/** The subset of primitive, enum, and m2o fields from the `F` that are settable, i.e. not derived. */
+type SettableFields<F> = { [K in keyof F]: F[K] extends {
+  kind: "primitive";
+  derived: false;
+} ? F[K] : F[K] extends {
+  kind: "enum";
+} ? F[K] : F[K] extends {
+  kind: "m2o";
+  derived: false;
+} ? F[K] : never; };
+//#endregion
+export { EntityField, EntityFields, SettableFields };
+//# sourceMappingURL=EntityFields.d.mts.map

package/build/EntityFields.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityFields.d.mts","names":[],"sources":["../src/EntityFields.ts"],"mappings":";;KACY,aAAa,QACtB,WAAW,IAAI;KAGN;EACN;EAAmB;EAAe;EAAiB;EAA6B;;EAChF;EAAc;EAAe;;EAC7B;EAAa;EAAe;EAA2B;;EACvD;EAAc;EAAe;;;KAGvB,eAAe,QACxB,WAAW,IAAI,EAAE;EAAa;EAAmB;IAC9C,EAAE,KACF,EAAE;EAAa;IACb,EAAE,KACF,EAAE;EAAa;EAAa;IAC1B,EAAE"}

package/build/EntityFields.js

@@ -1,3 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=EntityFields.js.map
+export {};