joist-core 2.3.0 → 2.4.0-next.2

package/build/keys.cjs

@@ -0,0 +1,181 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("./relations/index.cjs");
+const require_utils = require("./utils.cjs");
+const require_EntityMetadata = require("./EntityMetadata.cjs");
+require("./EntityManager.cjs");
+const require_Entity = require("./Entity.cjs");
+const require_BaseEntity = require("./BaseEntity.cjs");
+//#region src/keys.ts
+let tagDelimiter = ":";
+/** Sets the process-wide tagged-id format during metadata boot. */
+function setTaggedIdDelimiter(delimiter) {
+	tagDelimiter = delimiter;
+}
+/** Converts our internal/always-tagged `id` to the domain entity's `id` type (could be a number or uuid). */
+function toIdOf(meta, id) {
+	if (!id) return void 0;
+	switch (meta.idType) {
+		case "number": return Number(deTagId(meta, id));
+		case "tagged-string": return id;
+		case "untagged-string": return deTagId(meta, id);
+		default: return require_utils.assertNever(meta.idType);
+	}
+}
+function maybeResolveReferenceToId(value) {
+	return typeof value === "string" ? value : value?.idTaggedMaybe;
+}
+function keyToNumber(meta, value) {
+	if (value === void 0 || value === null) return;
+	else if (typeof value === "number") return value;
+	else if (typeof value === "string") {
+		if (tagDelimiter === void 0) return maybeNumberUnlessUuid(meta, value.startsWith(meta.tagName) ? value.slice(meta.tagName.length) : value);
+		const delimiterIndex = value.indexOf(tagDelimiter);
+		if (delimiterIndex === -1) return maybeNumberUnlessUuid(meta, value);
+		if (value.slice(0, delimiterIndex) !== meta.tagName) throw new Error(`Invalid tagged id, expected tag ${meta.tagName}, got ${value}`);
+		return maybeNumberUnlessUuid(meta, value.slice(delimiterIndex + tagDelimiter.length));
+	} else throw new Error(`Invalid key ${value}`);
+}
+function maybeNumberUnlessUuid(meta, key) {
+	switch (meta.idDbType) {
+		case "bigint":
+		case "uuid":
+		case "text": return key;
+		case "int": return Number(key);
+		default: require_utils.assertNever(meta.idDbType);
+	}
+}
+/** Converts `dbValue` (big int, int, uuid) to a tagged string, unless its undefined. */
+function keyToTaggedId(meta, dbValue) {
+	if (dbValue === void 0 || dbValue === null) return void 0;
+	return `${taggedIdPrefix(meta)}${dbValue}`;
+}
+/** Returns the entity tag followed by the configured ID delimiter. */
+function taggedIdPrefix(meta) {
+	return `${meta.tagName}${tagDelimiter ?? ""}`;
+}
+/** Fails if any keys are untagged; internal batch-loader keys must always be tagged. */
+function assertIdsAreTagged(keys) {
+	for (const key of keys) if (!(tagDelimiter === void 0 ? validSlugId.test(key) : key.indexOf(tagDelimiter) !== -1)) throw new Error(`Key ${key} is missing a tag`);
+}
+const validSlugId = /^([a-z]+)(\d+)$/i;
+const uuidIshId = /[0-9a-z-]+/i;
+function isTaggedId(metaOrId, id) {
+	if (typeof metaOrId === "number") return false;
+	else if (typeof metaOrId === "string") return tagDelimiter === void 0 ? validSlugId.test(metaOrId) : hasTagDelimiter(metaOrId);
+	else return isTaggedIdForMeta(metaOrId, id);
+}
+function assertIdIsTagged(id) {
+	if (!isTaggedId(id)) throw new Error(`Key is not tagged ${id}`);
+}
+function toTaggedId(meta, id) {
+	if (typeof id === "number") return `${meta.tagName}${tagDelimiter ?? ""}${id}`;
+	else if (typeof id === "string") {
+		if (id === "") return void 0;
+		if (tagDelimiter === void 0) {
+			const tag = validSlugId.exec(id)?.[1];
+			if (tag && tag !== meta.tagName) throw new Error(`Invalid tagged id, expected tag ${meta.tagName}, got ${id}`);
+			return tag ? id : `${meta.tagName}${id}`;
+		} else {
+			const i = id.indexOf(tagDelimiter);
+			if (i === -1) return `${meta.tagName}${tagDelimiter}${id}`;
+			if (id.slice(0, i) !== meta.tagName) throw new Error(`Invalid tagged id, expected tag ${meta.tagName}, got ${id}`);
+		}
+	}
+	return id;
+}
+/** Similar to `toTaggedId`, but we accept an entity for handling relations to not-yet-saved entities. */
+function ensureTagged(meta, value) {
+	return require_Entity.isEntity(value) ? value : toTaggedId(meta, value);
+}
+function tagId(metaOrCstr, id) {
+	const tag = metadata(metaOrCstr).tagName;
+	if (typeof id === "number") return `${tag}${tagDelimiter ?? ""}${id}`;
+	if (id === null || id === void 0) return;
+	if (tagDelimiter === void 0) {
+		const existingTag = validSlugId.exec(id)?.[1];
+		if (existingTag && existingTag !== tag) throw new Error(`Invalid tagged id, expected tag ${tag}, got ${id}`);
+		return existingTag ? id : `${tag}${id}`;
+	}
+	const delimiterIndex = id.indexOf(tagDelimiter);
+	if (delimiterIndex !== -1) {
+		if (delimiterIndex !== tag.length || !id.startsWith(tag)) throw new Error(`Invalid tagged id, expected tag ${tag}, got ${id}`);
+		return id;
+	}
+	return `${tag}${tagDelimiter}${id}`;
+}
+function tagIds(metaOrCstr, keys) {
+	return keys.map((k) => tagId(metaOrCstr, k));
+}
+function deTagId(entityOrMeta, id) {
+	const meta = entityOrMeta instanceof require_BaseEntity.BaseEntity ? require_EntityMetadata.getMetadata(entityOrMeta) : entityOrMeta;
+	id = id ?? entityOrMeta.id;
+	return id === void 0 ? void 0 : keyToNumber(meta, id).toString();
+}
+/** Removes the tag prefixes so we can use the keys for SQL operations. */
+function deTagIds(meta, keys) {
+	const deTagged = Array(keys.length);
+	for (let i = 0; i < keys.length; i++) deTagged[i] = deTagId(meta, keys[i]);
+	return deTagged;
+}
+/** Removes the tag prefixes so we can use the keys for SQL operations. */
+function unsafeDeTagIds(keys) {
+	const deTagged = Array(keys.length);
+	for (let i = 0; i < keys.length; i++) if (tagDelimiter === void 0) deTagged[i] = validSlugId.exec(keys[i])?.[2];
+	else {
+		const delimiterIndex = keys[i].indexOf(tagDelimiter);
+		deTagged[i] = delimiterIndex === -1 ? void 0 : keys[i].slice(delimiterIndex + tagDelimiter.length);
+	}
+	return deTagged;
+}
+/** Given a tagged id, returns its tag. */
+function tagFromId(id) {
+	if (tagDelimiter === void 0) return validSlugId.exec(id)?.[1] ?? require_utils.fail(`Unknown tagged id format: "${id}"`);
+	const delimiterIndex = id.indexOf(tagDelimiter);
+	return delimiterIndex > 0 && delimiterIndex + tagDelimiter.length < id.length ? id.slice(0, delimiterIndex) : require_utils.fail(`Unknown tagged id format: "${id}"`);
+}
+/** Returns the metadata needed to format an id. */
+function metadata(metaOrCstr) {
+	return typeof metaOrCstr === "function" ? require_EntityMetadata.getMetadata(metaOrCstr) : metaOrCstr;
+}
+/** Returns whether `id` has the tag and database id shape required by `meta`. */
+function isTaggedIdForMeta(meta, id) {
+	if (tagDelimiter === void 0) return validSlugId.exec(id)?.[1] === meta.tagName;
+	const delimiterIndex = id.indexOf(tagDelimiter);
+	if (delimiterIndex === -1) return false;
+	const tag = id.slice(0, delimiterIndex);
+	const untaggedId = id.slice(delimiterIndex + tagDelimiter.length);
+	if (meta.tagName !== tag) return false;
+	switch (meta.idDbType) {
+		case "int":
+		case "bigint": return !Number.isNaN(Number(untaggedId));
+		case "uuid": return uuidIshId.test(untaggedId);
+		case "text": return true;
+		default: return require_utils.assertNever(meta.idDbType);
+	}
+}
+/** Returns whether `id` has a non-empty tag and value separated by the configured delimiter. */
+function hasTagDelimiter(id) {
+	if (tagDelimiter === void 0) return false;
+	const delimiterIndex = id.indexOf(tagDelimiter);
+	return delimiterIndex > 0 && delimiterIndex + tagDelimiter.length < id.length;
+}
+//#endregion
+exports.assertIdIsTagged = assertIdIsTagged;
+exports.assertIdsAreTagged = assertIdsAreTagged;
+exports.deTagId = deTagId;
+exports.deTagIds = deTagIds;
+exports.ensureTagged = ensureTagged;
+exports.isTaggedId = isTaggedId;
+exports.keyToNumber = keyToNumber;
+exports.keyToTaggedId = keyToTaggedId;
+exports.maybeResolveReferenceToId = maybeResolveReferenceToId;
+exports.setTaggedIdDelimiter = setTaggedIdDelimiter;
+exports.tagFromId = tagFromId;
+exports.tagId = tagId;
+exports.tagIds = tagIds;
+exports.taggedIdPrefix = taggedIdPrefix;
+exports.toIdOf = toIdOf;
+exports.toTaggedId = toTaggedId;
+exports.unsafeDeTagIds = unsafeDeTagIds;
+
+//# sourceMappingURL=keys.cjs.map

package/build/keys.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.cjs","names":["assertNever","isEntity","BaseEntity","getMetadata","fail"],"sources":["../src/keys.ts"],"sourcesContent":["import { BaseEntity } from \"src/BaseEntity.ts\";\nimport { type Entity, type IdType, isEntity } from \"src/Entity.ts\";\nimport { type EntityConstructor, type IdOf, type TaggedId } from \"src/EntityManager.ts\";\nimport { type EntityMetadata, getMetadata } from \"src/EntityMetadata.ts\";\nimport { type Reference } from \"src/relations/index.ts\";\nimport { assertNever, fail } from \"src/utils.ts\";\n\nlet tagDelimiter: string | undefined = \":\";\n\n/** Sets the process-wide tagged-id format during metadata boot. */\nexport function setTaggedIdDelimiter(delimiter: string | undefined): void {\n  tagDelimiter = delimiter;\n}\n\n// I'm not entirely sure this is still necessary, but use a small subset of EntityMetadata so\n// that this file doesn't have to import the type and potentially create import cycles.\ntype HasTagName = {\n  tagName: string;\n  /** The database column type, i.e. used to do `::type` casts in Postgres. */\n  idDbType: \"bigint\" | \"int\" | \"uuid\" | \"text\";\n};\n\n/** Converts our internal/always-tagged `id` to the domain entity's `id` type (could be a number or uuid). */\nexport function toIdOf<T extends Entity>(meta: EntityMetadata<T>, id: TaggedId | undefined): IdOf<T> | undefined {\n  if (!id) return undefined;\n  switch (meta.idType) {\n    case \"number\":\n      return Number(deTagId(meta, id)) as IdOf<T>;\n    case \"tagged-string\":\n      return id as IdOf<T>;\n    case \"untagged-string\":\n      return deTagId(meta, id) as IdOf<T>;\n    default:\n      return assertNever(meta.idType);\n  }\n}\n\n// Before a referred-to object is saved, we keep its instance in our data\n// map, and then assume it will be persisted before we're asked to persist\nexport function maybeResolveReferenceToId(\n  value: Entity | Reference<any, any, any> | string | undefined,\n): TaggedId | undefined {\n  return typeof value === \"string\" ? value : value?.idTaggedMaybe;\n}\n\n/** Converts `value` to a number, i.e. for string ids, unless its undefined. */\nexport function keyToNumber(meta: HasTagName, value: string | number): number;\nexport function keyToNumber(meta: HasTagName, value: string | number | undefined): number | undefined;\nexport function keyToNumber(meta: HasTagName, value: any): number | undefined {\n  if (value === undefined || value === null) {\n    return undefined;\n  } else if (typeof value === \"number\") {\n    return value;\n  } else if (typeof value === \"string\") {\n    if (tagDelimiter === undefined) {\n      const id = value.startsWith(meta.tagName) ? value.slice(meta.tagName.length) : value;\n      return maybeNumberUnlessUuid(meta, id);\n    }\n    const delimiterIndex = value.indexOf(tagDelimiter);\n    if (delimiterIndex === -1) {\n      return maybeNumberUnlessUuid(meta, value);\n    }\n    const tag = value.slice(0, delimiterIndex);\n    if (tag !== meta.tagName) {\n      throw new Error(`Invalid tagged id, expected tag ${meta.tagName}, got ${value}`);\n    }\n    return maybeNumberUnlessUuid(meta, value.slice(delimiterIndex + tagDelimiter.length));\n  } else {\n    throw new Error(`Invalid key ${value}`);\n  }\n}\n\n// UUIDs, text, and bigints are strings at the database boundary, so lie to the type system and pretend they're numbers.\nfunction maybeNumberUnlessUuid(meta: HasTagName, key: string): number {\n  switch (meta.idDbType) {\n    case \"bigint\":\n    case \"uuid\":\n    case \"text\":\n      return key as any;\n    case \"int\":\n      return Number(key);\n    default:\n      assertNever(meta.idDbType);\n  }\n}\n\n/** Converts `dbValue` (big int, int, uuid) to a tagged string, unless its undefined. */\nexport function keyToTaggedId(meta: HasTagName, dbValue: string | number): TaggedId | undefined {\n  if (dbValue === undefined || dbValue === null) return undefined;\n  return `${taggedIdPrefix(meta)}${dbValue}`;\n}\n\n/** Returns the entity tag followed by the configured ID delimiter. */\nexport function taggedIdPrefix(meta: Pick<HasTagName, \"tagName\">): string {\n  return `${meta.tagName}${tagDelimiter ?? \"\"}`;\n}\n\n/** Fails if any keys are untagged; internal batch-loader keys must always be tagged. */\nexport function assertIdsAreTagged(keys: readonly string[]): void {\n  for (const key of keys) {\n    const isTagged = tagDelimiter === undefined ? validSlugId.test(key) : key.indexOf(tagDelimiter) !== -1;\n    if (!isTagged) throw new Error(`Key ${key} is missing a tag`);\n  }\n}\n\nconst validSlugId = /^([a-z]+)(\\d+)$/i;\nconst uuidIshId = /[0-9a-z-]+/i;\n\n/** Returns whether `id` is tagged and a probably-correct value. */\nexport function isTaggedId(id: string | number): boolean;\n/** Returns whether `id` is tagged and the tag matches `meta`'s tag. */\nexport function isTaggedId(meta: EntityMetadata, id: string): boolean;\nexport function isTaggedId(metaOrId: string | number | HasTagName, id?: string): boolean {\n  if (typeof metaOrId === \"number\") {\n    // number overload\n    return false;\n  } else if (typeof metaOrId === \"string\") {\n    // string overload\n    return tagDelimiter === undefined ? validSlugId.test(metaOrId) : hasTagDelimiter(metaOrId);\n  } else {\n    // meta + string overload\n    return isTaggedIdForMeta(metaOrId, id!);\n  }\n}\n\nexport function assertIdIsTagged(id: string): void {\n  if (!isTaggedId(id)) {\n    throw new Error(`Key is not tagged ${id}`);\n  }\n}\n\n/** We accept an entity in case this is m2o storing a not-yet-saved entity. */\nexport function toTaggedId(meta: HasTagName, id: IdType): TaggedId;\nexport function toTaggedId(meta: HasTagName, id: IdType | undefined): TaggedId | undefined;\nexport function toTaggedId(meta: HasTagName, id: IdType | undefined): TaggedId | undefined {\n  if (typeof id === \"number\") {\n    return `${meta.tagName}${tagDelimiter ?? \"\"}${id}`;\n  } else if (typeof id === \"string\") {\n    // This seems odd, but is covered by a unit test, so I guess we need it?\n    if (id === \"\") return undefined;\n    if (tagDelimiter === undefined) {\n      const tag = validSlugId.exec(id)?.[1];\n      if (tag && tag !== meta.tagName) {\n        throw new Error(`Invalid tagged id, expected tag ${meta.tagName}, got ${id}`);\n      }\n      return tag ? id : `${meta.tagName}${id}`;\n    } else {\n      const i = id.indexOf(tagDelimiter);\n      if (i === -1) return `${meta.tagName}${tagDelimiter}${id}`;\n      const tag = id.slice(0, i);\n      if (tag !== meta.tagName) {\n        throw new Error(`Invalid tagged id, expected tag ${meta.tagName}, got ${id}`);\n      }\n    }\n  }\n  return id;\n}\n\n/** Similar to `toTaggedId`, but we accept an entity for handling relations to not-yet-saved entities. */\nexport function ensureTagged<T extends Entity>(\n  meta: HasTagName,\n  value: T | string | number | undefined,\n): T | TaggedId | undefined {\n  return isEntity(value) ? value : toTaggedId(meta, value);\n}\n\n/** Tags a potentially untagged id, while our API inputs still accept either tagged or untagged ids. */\nexport function tagId(meta: HasTagName, id: string | number): string;\nexport function tagId(cstr: EntityConstructor<any>, id: string | number): string;\nexport function tagId(meta: HasTagName, id: string | number | null | undefined): string | undefined;\nexport function tagId(cstr: EntityConstructor<any>, id: string | number | null | undefined): string | undefined;\nexport function tagId(\n  metaOrCstr: HasTagName | EntityConstructor<any>,\n  id: string | number | null | undefined,\n): string | undefined {\n  const meta = metadata(metaOrCstr);\n  const tag = meta.tagName;\n  if (typeof id === \"number\") {\n    return `${tag}${tagDelimiter ?? \"\"}${id}`;\n  }\n  if (id === null || id === undefined) {\n    return undefined;\n  }\n  if (tagDelimiter === undefined) {\n    const existingTag = validSlugId.exec(id)?.[1];\n    if (existingTag && existingTag !== tag) {\n      throw new Error(`Invalid tagged id, expected tag ${tag}, got ${id}`);\n    }\n    return existingTag ? id : `${tag}${id}`;\n  }\n  // Avoid using includes/split, for a faster indexOf + length + startsWith\n  const delimiterIndex = id.indexOf(tagDelimiter);\n  if (delimiterIndex !== -1) {\n    if (delimiterIndex !== tag.length || !id.startsWith(tag)) {\n      throw new Error(`Invalid tagged id, expected tag ${tag}, got ${id}`);\n    }\n    return id;\n  }\n  return `${tag}${tagDelimiter}${id}`;\n}\n\n/** Adds the tag prefixes. */\nexport function tagIds(meta: HasTagName, keys: readonly (string | number)[]): readonly string[];\nexport function tagIds(cstr: EntityConstructor<any>, keys: readonly (string | number)[]): readonly string[];\nexport function tagIds(\n  metaOrCstr: HasTagName | EntityConstructor<any>,\n  keys: readonly (string | number)[],\n): readonly string[] {\n  return keys.map((k) => tagId(metaOrCstr as any, k));\n}\n\nexport function deTagId(meta: HasTagName, id: string | number): string;\nexport function deTagId(meta: HasTagName, id: string | number | undefined): string | undefined;\nexport function deTagId(entity: Entity): string;\nexport function deTagId(entityOrMeta: Entity | HasTagName, id?: string | number): string | undefined {\n  const meta = entityOrMeta instanceof BaseEntity ? getMetadata(entityOrMeta) : (entityOrMeta as HasTagName);\n  id = id ?? (entityOrMeta as Entity).id;\n  return id === undefined ? undefined : keyToNumber(meta, id).toString();\n}\n\n/** Removes the tag prefixes so we can use the keys for SQL operations. */\nexport function deTagIds(meta: HasTagName, keys: readonly string[]): readonly string[] {\n  const deTagged = Array(keys.length);\n  for (let i = 0; i < keys.length; i++) deTagged[i] = deTagId(meta, keys[i]);\n  return deTagged;\n}\n\n/** Removes the tag prefixes so we can use the keys for SQL operations. */\nexport function unsafeDeTagIds(keys: readonly string[]): readonly string[] {\n  const deTagged = Array(keys.length);\n  for (let i = 0; i < keys.length; i++) {\n    if (tagDelimiter === undefined) {\n      deTagged[i] = validSlugId.exec(keys[i])?.[2];\n    } else {\n      const delimiterIndex = keys[i].indexOf(tagDelimiter);\n      deTagged[i] = delimiterIndex === -1 ? undefined : keys[i].slice(delimiterIndex + tagDelimiter.length);\n    }\n  }\n  return deTagged;\n}\n\n/** Given a tagged id, returns its tag. */\nexport function tagFromId(id: string): string {\n  if (tagDelimiter === undefined) {\n    return validSlugId.exec(id)?.[1] ?? fail(`Unknown tagged id format: \"${id}\"`);\n  }\n  const delimiterIndex = id.indexOf(tagDelimiter);\n  return delimiterIndex > 0 && delimiterIndex + tagDelimiter.length < id.length\n    ? id.slice(0, delimiterIndex)\n    : fail(`Unknown tagged id format: \"${id}\"`);\n}\n\n/** Returns the metadata needed to format an id. */\nfunction metadata(metaOrCstr: HasTagName | EntityConstructor<any>): HasTagName {\n  return typeof metaOrCstr === \"function\" ? getMetadata(metaOrCstr) : metaOrCstr;\n}\n\n/** Returns whether `id` has the tag and database id shape required by `meta`. */\nfunction isTaggedIdForMeta(meta: HasTagName, id: string): boolean {\n  if (tagDelimiter === undefined) {\n    return validSlugId.exec(id)?.[1] === meta.tagName;\n  }\n  const delimiterIndex = id.indexOf(tagDelimiter);\n  if (delimiterIndex === -1) return false;\n  const tag = id.slice(0, delimiterIndex);\n  const untaggedId = id.slice(delimiterIndex + tagDelimiter.length);\n  if (meta.tagName !== tag) return false;\n  switch (meta.idDbType) {\n    case \"int\":\n    case \"bigint\":\n      return !Number.isNaN(Number(untaggedId));\n    case \"uuid\":\n      return uuidIshId.test(untaggedId);\n    case \"text\":\n      return true;\n    default:\n      return assertNever(meta.idDbType);\n  }\n}\n\n/** Returns whether `id` has a non-empty tag and value separated by the configured delimiter. */\nfunction hasTagDelimiter(id: string): boolean {\n  if (tagDelimiter === undefined) return false;\n  const delimiterIndex = id.indexOf(tagDelimiter);\n  return delimiterIndex > 0 && delimiterIndex + tagDelimiter.length < id.length;\n}\n"],"mappings":";;;;;;;;AAOA,IAAI,eAAmC;;AAGvC,SAAgB,qBAAqB,WAAqC;CACxE,eAAe;AACjB;;AAWA,SAAgB,OAAyB,MAAyB,IAA+C;CAC/G,IAAI,CAAC,IAAI,OAAO,KAAA;CAChB,QAAQ,KAAK,QAAb;EACE,KAAK,UACH,OAAO,OAAO,QAAQ,MAAM,EAAE,CAAC;EACjC,KAAK,iBACH,OAAO;EACT,KAAK,mBACH,OAAO,QAAQ,MAAM,EAAE;EACzB,SACE,OAAOA,cAAAA,YAAY,KAAK,MAAM;CAClC;AACF;AAIA,SAAgB,0BACd,OACsB;CACtB,OAAO,OAAO,UAAU,WAAW,QAAQ,OAAO;AACpD;AAKA,SAAgB,YAAY,MAAkB,OAAgC;CAC5E,IAAI,UAAU,KAAA,KAAa,UAAU,MACnC;MACK,IAAI,OAAO,UAAU,UAC1B,OAAO;MACF,IAAI,OAAO,UAAU,UAAU;EACpC,IAAI,iBAAiB,KAAA,GAEnB,OAAO,sBAAsB,MADlB,MAAM,WAAW,KAAK,OAAO,IAAI,MAAM,MAAM,KAAK,QAAQ,MAAM,IAAI,KAC1C;EAEvC,MAAM,iBAAiB,MAAM,QAAQ,YAAY;EACjD,IAAI,mBAAmB,IACrB,OAAO,sBAAsB,MAAM,KAAK;EAG1C,IADY,MAAM,MAAM,GAAG,cACrB,MAAM,KAAK,SACf,MAAM,IAAI,MAAM,mCAAmC,KAAK,QAAQ,QAAQ,OAAO;EAEjF,OAAO,sBAAsB,MAAM,MAAM,MAAM,iBAAiB,aAAa,MAAM,CAAC;CACtF,OACE,MAAM,IAAI,MAAM,eAAe,OAAO;AAE1C;AAGA,SAAS,sBAAsB,MAAkB,KAAqB;CACpE,QAAQ,KAAK,UAAb;EACE,KAAK;EACL,KAAK;EACL,KAAK,QACH,OAAO;EACT,KAAK,OACH,OAAO,OAAO,GAAG;EACnB,SACE,cAAA,YAAY,KAAK,QAAQ;CAC7B;AACF;;AAGA,SAAgB,cAAc,MAAkB,SAAgD;CAC9F,IAAI,YAAY,KAAA,KAAa,YAAY,MAAM,OAAO,KAAA;CACtD,OAAO,GAAG,eAAe,IAAI,IAAI;AACnC;;AAGA,SAAgB,eAAe,MAA2C;CACxE,OAAO,GAAG,KAAK,UAAU,gBAAgB;AAC3C;;AAGA,SAAgB,mBAAmB,MAA+B;CAChE,KAAK,MAAM,OAAO,MAEhB,IAAI,EADa,iBAAiB,KAAA,IAAY,YAAY,KAAK,GAAG,IAAI,IAAI,QAAQ,YAAY,MAAM,KACrF,MAAM,IAAI,MAAM,OAAO,IAAI,kBAAkB;AAEhE;AAEA,MAAM,cAAc;AACpB,MAAM,YAAY;AAMlB,SAAgB,WAAW,UAAwC,IAAsB;CACvF,IAAI,OAAO,aAAa,UAEtB,OAAO;MACF,IAAI,OAAO,aAAa,UAE7B,OAAO,iBAAiB,KAAA,IAAY,YAAY,KAAK,QAAQ,IAAI,gBAAgB,QAAQ;MAGzF,OAAO,kBAAkB,UAAU,EAAG;AAE1C;AAEA,SAAgB,iBAAiB,IAAkB;CACjD,IAAI,CAAC,WAAW,EAAE,GAChB,MAAM,IAAI,MAAM,qBAAqB,IAAI;AAE7C;AAKA,SAAgB,WAAW,MAAkB,IAA8C;CACzF,IAAI,OAAO,OAAO,UAChB,OAAO,GAAG,KAAK,UAAU,gBAAgB,KAAK;MACzC,IAAI,OAAO,OAAO,UAAU;EAEjC,IAAI,OAAO,IAAI,OAAO,KAAA;EACtB,IAAI,iBAAiB,KAAA,GAAW;GAC9B,MAAM,MAAM,YAAY,KAAK,EAAE,CAAC,GAAG;GACnC,IAAI,OAAO,QAAQ,KAAK,SACtB,MAAM,IAAI,MAAM,mCAAmC,KAAK,QAAQ,QAAQ,IAAI;GAE9E,OAAO,MAAM,KAAK,GAAG,KAAK,UAAU;EACtC,OAAO;GACL,MAAM,IAAI,GAAG,QAAQ,YAAY;GACjC,IAAI,MAAM,IAAI,OAAO,GAAG,KAAK,UAAU,eAAe;GAEtD,IADY,GAAG,MAAM,GAAG,CAClB,MAAM,KAAK,SACf,MAAM,IAAI,MAAM,mCAAmC,KAAK,QAAQ,QAAQ,IAAI;EAEhF;CACF;CACA,OAAO;AACT;;AAGA,SAAgB,aACd,MACA,OAC0B;CAC1B,OAAOC,eAAAA,SAAS,KAAK,IAAI,QAAQ,WAAW,MAAM,KAAK;AACzD;AAOA,SAAgB,MACd,YACA,IACoB;CAEpB,MAAM,MADO,SAAS,UACP,CAAC,CAAC;CACjB,IAAI,OAAO,OAAO,UAChB,OAAO,GAAG,MAAM,gBAAgB,KAAK;CAEvC,IAAI,OAAO,QAAQ,OAAO,KAAA,GACxB;CAEF,IAAI,iBAAiB,KAAA,GAAW;EAC9B,MAAM,cAAc,YAAY,KAAK,EAAE,CAAC,GAAG;EAC3C,IAAI,eAAe,gBAAgB,KACjC,MAAM,IAAI,MAAM,mCAAmC,IAAI,QAAQ,IAAI;EAErE,OAAO,cAAc,KAAK,GAAG,MAAM;CACrC;CAEA,MAAM,iBAAiB,GAAG,QAAQ,YAAY;CAC9C,IAAI,mBAAmB,IAAI;EACzB,IAAI,mBAAmB,IAAI,UAAU,CAAC,GAAG,WAAW,GAAG,GACrD,MAAM,IAAI,MAAM,mCAAmC,IAAI,QAAQ,IAAI;EAErE,OAAO;CACT;CACA,OAAO,GAAG,MAAM,eAAe;AACjC;AAKA,SAAgB,OACd,YACA,MACmB;CACnB,OAAO,KAAK,KAAK,MAAM,MAAM,YAAmB,CAAC,CAAC;AACpD;AAKA,SAAgB,QAAQ,cAAmC,IAA0C;CACnG,MAAM,OAAO,wBAAwBC,mBAAAA,aAAaC,uBAAAA,YAAY,YAAY,IAAK;CAC/E,KAAK,MAAO,aAAwB;CACpC,OAAO,OAAO,KAAA,IAAY,KAAA,IAAY,YAAY,MAAM,EAAE,CAAC,CAAC,SAAS;AACvE;;AAGA,SAAgB,SAAS,MAAkB,MAA4C;CACrF,MAAM,WAAW,MAAM,KAAK,MAAM;CAClC,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK,SAAS,KAAK,QAAQ,MAAM,KAAK,EAAE;CACzE,OAAO;AACT;;AAGA,SAAgB,eAAe,MAA4C;CACzE,MAAM,WAAW,MAAM,KAAK,MAAM;CAClC,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,QAAQ,KAC/B,IAAI,iBAAiB,KAAA,GACnB,SAAS,KAAK,YAAY,KAAK,KAAK,EAAE,CAAC,GAAG;MACrC;EACL,MAAM,iBAAiB,KAAK,EAAE,CAAC,QAAQ,YAAY;EACnD,SAAS,KAAK,mBAAmB,KAAK,KAAA,IAAY,KAAK,EAAE,CAAC,MAAM,iBAAiB,aAAa,MAAM;CACtG;CAEF,OAAO;AACT;;AAGA,SAAgB,UAAU,IAAoB;CAC5C,IAAI,iBAAiB,KAAA,GACnB,OAAO,YAAY,KAAK,EAAE,CAAC,GAAG,MAAMC,cAAAA,KAAK,8BAA8B,GAAG,EAAE;CAE9E,MAAM,iBAAiB,GAAG,QAAQ,YAAY;CAC9C,OAAO,iBAAiB,KAAK,iBAAiB,aAAa,SAAS,GAAG,SACnE,GAAG,MAAM,GAAG,cAAc,IAC1BA,cAAAA,KAAK,8BAA8B,GAAG,EAAE;AAC9C;;AAGA,SAAS,SAAS,YAA6D;CAC7E,OAAO,OAAO,eAAe,aAAaD,uBAAAA,YAAY,UAAU,IAAI;AACtE;;AAGA,SAAS,kBAAkB,MAAkB,IAAqB;CAChE,IAAI,iBAAiB,KAAA,GACnB,OAAO,YAAY,KAAK,EAAE,CAAC,GAAG,OAAO,KAAK;CAE5C,MAAM,iBAAiB,GAAG,QAAQ,YAAY;CAC9C,IAAI,mBAAmB,IAAI,OAAO;CAClC,MAAM,MAAM,GAAG,MAAM,GAAG,cAAc;CACtC,MAAM,aAAa,GAAG,MAAM,iBAAiB,aAAa,MAAM;CAChE,IAAI,KAAK,YAAY,KAAK,OAAO;CACjC,QAAQ,KAAK,UAAb;EACE,KAAK;EACL,KAAK,UACH,OAAO,CAAC,OAAO,MAAM,OAAO,UAAU,CAAC;EACzC,KAAK,QACH,OAAO,UAAU,KAAK,UAAU;EAClC,KAAK,QACH,OAAO;EACT,SACE,OAAOH,cAAAA,YAAY,KAAK,QAAQ;CACpC;AACF;;AAGA,SAAS,gBAAgB,IAAqB;CAC5C,IAAI,iBAAiB,KAAA,GAAW,OAAO;CACvC,MAAM,iBAAiB,GAAG,QAAQ,YAAY;CAC9C,OAAO,iBAAiB,KAAK,iBAAiB,aAAa,SAAS,GAAG;AACzE"}

package/build/keys.d.cts

@@ -0,0 +1,55 @@
+import { Reference } from "./relations/Reference.cjs";
+import "./relations/index.cjs";
+import { EntityMetadata } from "./EntityMetadata.cjs";
+import { EntityConstructor, IdOf, TaggedId } from "./EntityManager.cjs";
+import { Entity, IdType } from "./Entity.cjs";
+//#region src/keys.d.ts
+/** Sets the process-wide tagged-id format during metadata boot. */
+declare function setTaggedIdDelimiter(delimiter: string | undefined): void;
+type HasTagName = {
+  tagName: string;
+  /** The database column type, i.e. used to do `::type` casts in Postgres. */
+  idDbType: "bigint" | "int" | "uuid" | "text";
+};
+/** Converts our internal/always-tagged `id` to the domain entity's `id` type (could be a number or uuid). */
+declare function toIdOf<T extends Entity>(meta: EntityMetadata<T>, id: TaggedId | undefined): IdOf<T> | undefined;
+declare function maybeResolveReferenceToId(value: Entity | Reference<any, any, any> | string | undefined): TaggedId | undefined;
+/** Converts `value` to a number, i.e. for string ids, unless its undefined. */
+declare function keyToNumber(meta: HasTagName, value: string | number): number;
+declare function keyToNumber(meta: HasTagName, value: string | number | undefined): number | undefined;
+/** Converts `dbValue` (big int, int, uuid) to a tagged string, unless its undefined. */
+declare function keyToTaggedId(meta: HasTagName, dbValue: string | number): TaggedId | undefined;
+/** Returns the entity tag followed by the configured ID delimiter. */
+declare function taggedIdPrefix(meta: Pick<HasTagName, "tagName">): string;
+/** Fails if any keys are untagged; internal batch-loader keys must always be tagged. */
+declare function assertIdsAreTagged(keys: readonly string[]): void;
+/** Returns whether `id` is tagged and a probably-correct value. */
+declare function isTaggedId(id: string | number): boolean;
+/** Returns whether `id` is tagged and the tag matches `meta`'s tag. */
+declare function isTaggedId(meta: EntityMetadata, id: string): boolean;
+declare function assertIdIsTagged(id: string): void;
+/** We accept an entity in case this is m2o storing a not-yet-saved entity. */
+declare function toTaggedId(meta: HasTagName, id: IdType): TaggedId;
+declare function toTaggedId(meta: HasTagName, id: IdType | undefined): TaggedId | undefined;
+/** Similar to `toTaggedId`, but we accept an entity for handling relations to not-yet-saved entities. */
+declare function ensureTagged<T extends Entity>(meta: HasTagName, value: T | string | number | undefined): T | TaggedId | undefined;
+/** Tags a potentially untagged id, while our API inputs still accept either tagged or untagged ids. */
+declare function tagId(meta: HasTagName, id: string | number): string;
+declare function tagId(cstr: EntityConstructor<any>, id: string | number): string;
+declare function tagId(meta: HasTagName, id: string | number | null | undefined): string | undefined;
+declare function tagId(cstr: EntityConstructor<any>, id: string | number | null | undefined): string | undefined;
+/** Adds the tag prefixes. */
+declare function tagIds(meta: HasTagName, keys: readonly (string | number)[]): readonly string[];
+declare function tagIds(cstr: EntityConstructor<any>, keys: readonly (string | number)[]): readonly string[];
+declare function deTagId(meta: HasTagName, id: string | number): string;
+declare function deTagId(meta: HasTagName, id: string | number | undefined): string | undefined;
+declare function deTagId(entity: Entity): string;
+/** Removes the tag prefixes so we can use the keys for SQL operations. */
+declare function deTagIds(meta: HasTagName, keys: readonly string[]): readonly string[];
+/** Removes the tag prefixes so we can use the keys for SQL operations. */
+declare function unsafeDeTagIds(keys: readonly string[]): readonly string[];
+/** Given a tagged id, returns its tag. */
+declare function tagFromId(id: string): string;
+//#endregion
+export { assertIdIsTagged, assertIdsAreTagged, deTagId, deTagIds, ensureTagged, isTaggedId, keyToNumber, keyToTaggedId, maybeResolveReferenceToId, setTaggedIdDelimiter, tagFromId, tagId, tagIds, taggedIdPrefix, toIdOf, toTaggedId, unsafeDeTagIds };
+//# sourceMappingURL=keys.d.cts.map

package/build/keys.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.d.cts","names":[],"sources":["../src/keys.ts"],"mappings":";;;;;;;iBAUgB,qBAAqB;KAMhC;EACH;;EAEA;;;iBAIc,OAAO,UAAU,QAAQ,MAAM,eAAe,IAAI,IAAI,uBAAuB,KAAK;iBAgBlF,0BACd,OAAO,SAAS,gDACf;;iBAKa,YAAY,MAAM,YAAY;iBAC9B,YAAY,MAAM,YAAY;;iBAwC9B,cAAc,MAAM,YAAY,2BAA2B;;iBAM3D,eAAe,MAAM,KAAK;;iBAK1B,mBAAmB;;iBAWnB,WAAW;;iBAEX,WAAW,MAAM,gBAAgB;iBAcjC,iBAAiB;;iBAOjB,WAAW,MAAM,YAAY,IAAI,SAAS;iBAC1C,WAAW,MAAM,YAAY,IAAI,qBAAqB;;iBA0BtD,aAAa,UAAU,QACrC,MAAM,YACN,OAAO,kCACN,IAAI;;iBAKS,MAAM,MAAM,YAAY;iBACxB,MAAM,MAAM,wBAAwB;iBACpC,MAAM,MAAM,YAAY;iBACxB,MAAM,MAAM,wBAAwB;;iBAgCpC,OAAO,MAAM,YAAY;iBACzB,OAAO,MAAM,wBAAwB;iBAQrC,QAAQ,MAAM,YAAY;iBAC1B,QAAQ,MAAM,YAAY;iBAC1B,QAAQ,QAAQ;;iBAQhB,SAAS,MAAM,YAAY;;iBAO3B,eAAe;;iBAcf,UAAU"}

package/build/keys.d.mts

@@ -0,0 +1,55 @@
+import { Reference } from "./relations/Reference.mjs";
+import "./relations/index.mjs";
+import { EntityMetadata } from "./EntityMetadata.mjs";
+import { EntityConstructor, IdOf, TaggedId } from "./EntityManager.mjs";
+import { Entity, IdType } from "./Entity.mjs";
+//#region src/keys.d.ts
+/** Sets the process-wide tagged-id format during metadata boot. */
+declare function setTaggedIdDelimiter(delimiter: string | undefined): void;
+type HasTagName = {
+  tagName: string;
+  /** The database column type, i.e. used to do `::type` casts in Postgres. */
+  idDbType: "bigint" | "int" | "uuid" | "text";
+};
+/** Converts our internal/always-tagged `id` to the domain entity's `id` type (could be a number or uuid). */
+declare function toIdOf<T extends Entity>(meta: EntityMetadata<T>, id: TaggedId | undefined): IdOf<T> | undefined;
+declare function maybeResolveReferenceToId(value: Entity | Reference<any, any, any> | string | undefined): TaggedId | undefined;
+/** Converts `value` to a number, i.e. for string ids, unless its undefined. */
+declare function keyToNumber(meta: HasTagName, value: string | number): number;
+declare function keyToNumber(meta: HasTagName, value: string | number | undefined): number | undefined;
+/** Converts `dbValue` (big int, int, uuid) to a tagged string, unless its undefined. */
+declare function keyToTaggedId(meta: HasTagName, dbValue: string | number): TaggedId | undefined;
+/** Returns the entity tag followed by the configured ID delimiter. */
+declare function taggedIdPrefix(meta: Pick<HasTagName, "tagName">): string;
+/** Fails if any keys are untagged; internal batch-loader keys must always be tagged. */
+declare function assertIdsAreTagged(keys: readonly string[]): void;
+/** Returns whether `id` is tagged and a probably-correct value. */
+declare function isTaggedId(id: string | number): boolean;
+/** Returns whether `id` is tagged and the tag matches `meta`'s tag. */
+declare function isTaggedId(meta: EntityMetadata, id: string): boolean;
+declare function assertIdIsTagged(id: string): void;
+/** We accept an entity in case this is m2o storing a not-yet-saved entity. */
+declare function toTaggedId(meta: HasTagName, id: IdType): TaggedId;
+declare function toTaggedId(meta: HasTagName, id: IdType | undefined): TaggedId | undefined;
+/** Similar to `toTaggedId`, but we accept an entity for handling relations to not-yet-saved entities. */
+declare function ensureTagged<T extends Entity>(meta: HasTagName, value: T | string | number | undefined): T | TaggedId | undefined;
+/** Tags a potentially untagged id, while our API inputs still accept either tagged or untagged ids. */
+declare function tagId(meta: HasTagName, id: string | number): string;
+declare function tagId(cstr: EntityConstructor<any>, id: string | number): string;
+declare function tagId(meta: HasTagName, id: string | number | null | undefined): string | undefined;
+declare function tagId(cstr: EntityConstructor<any>, id: string | number | null | undefined): string | undefined;
+/** Adds the tag prefixes. */
+declare function tagIds(meta: HasTagName, keys: readonly (string | number)[]): readonly string[];
+declare function tagIds(cstr: EntityConstructor<any>, keys: readonly (string | number)[]): readonly string[];
+declare function deTagId(meta: HasTagName, id: string | number): string;
+declare function deTagId(meta: HasTagName, id: string | number | undefined): string | undefined;
+declare function deTagId(entity: Entity): string;
+/** Removes the tag prefixes so we can use the keys for SQL operations. */
+declare function deTagIds(meta: HasTagName, keys: readonly string[]): readonly string[];
+/** Removes the tag prefixes so we can use the keys for SQL operations. */
+declare function unsafeDeTagIds(keys: readonly string[]): readonly string[];
+/** Given a tagged id, returns its tag. */
+declare function tagFromId(id: string): string;
+//#endregion
+export { assertIdIsTagged, assertIdsAreTagged, deTagId, deTagIds, ensureTagged, isTaggedId, keyToNumber, keyToTaggedId, maybeResolveReferenceToId, setTaggedIdDelimiter, tagFromId, tagId, tagIds, taggedIdPrefix, toIdOf, toTaggedId, unsafeDeTagIds };
+//# sourceMappingURL=keys.d.mts.map

package/build/keys.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.d.mts","names":[],"sources":["../src/keys.ts"],"mappings":";;;;;;;iBAUgB,qBAAqB;KAMhC;EACH;;EAEA;;;iBAIc,OAAO,UAAU,QAAQ,MAAM,eAAe,IAAI,IAAI,uBAAuB,KAAK;iBAgBlF,0BACd,OAAO,SAAS,gDACf;;iBAKa,YAAY,MAAM,YAAY;iBAC9B,YAAY,MAAM,YAAY;;iBAwC9B,cAAc,MAAM,YAAY,2BAA2B;;iBAM3D,eAAe,MAAM,KAAK;;iBAK1B,mBAAmB;;iBAWnB,WAAW;;iBAEX,WAAW,MAAM,gBAAgB;iBAcjC,iBAAiB;;iBAOjB,WAAW,MAAM,YAAY,IAAI,SAAS;iBAC1C,WAAW,MAAM,YAAY,IAAI,qBAAqB;;iBA0BtD,aAAa,UAAU,QACrC,MAAM,YACN,OAAO,kCACN,IAAI;;iBAKS,MAAM,MAAM,YAAY;iBACxB,MAAM,MAAM,wBAAwB;iBACpC,MAAM,MAAM,YAAY;iBACxB,MAAM,MAAM,wBAAwB;;iBAgCpC,OAAO,MAAM,YAAY;iBACzB,OAAO,MAAM,wBAAwB;iBAQrC,QAAQ,MAAM,YAAY;iBAC1B,QAAQ,MAAM,YAAY;iBAC1B,QAAQ,QAAQ;;iBAQhB,SAAS,MAAM,YAAY;;iBAO3B,eAAe;;iBAcf,UAAU"}