@murumets-ee/entity 0.1.4 → 0.1.6

package/dist/refs/index.d.ts

@@ -1,263 +0,0 @@
-import { PostgresJsDatabase } from 'drizzle-orm/postgres-js';
-import * as drizzle_orm_pg_core from 'drizzle-orm/pg-core';
-
-/**
- * Generic entity usage lookup — "where is this entity referenced?"
- *
- * One indexed query on entity_refs instead of scanning every table.
- */
-
-interface EntityUsage {
-    sourceEntity: string;
-    sourceId: string;
-    sourceField: string;
-}
-/**
- * Find all entities that reference a given entity.
- *
- * @param targetEntity - Entity type name (e.g. 'media', 'category')
- * @param targetId     - UUID of the referenced entity
- * @param db           - Database connection
- * @returns Array of usage records (empty if unreferenced)
- */
-declare function findEntityUsages(targetEntity: string, targetId: string, db: PostgresJsDatabase): Promise<EntityUsage[]>;
-
-/**
- * Error thrown when attempting to delete an entity that is still referenced.
- */
-
-declare class ReferencedEntityError extends Error {
-    readonly entityName: string;
-    readonly entityId: string;
-    readonly usages: EntityUsage[];
-    constructor(entityName: string, entityId: string, usages: EntityUsage[]);
-}
-
-/**
- * Field type definitions
- * These define the structure and configuration for all field types
- */
-interface BaseFieldConfig {
-    required?: boolean;
-    default?: unknown;
-    translatable?: boolean;
-    indexed?: boolean;
-    unique?: boolean;
-    access?: {
-        view?: string;
-        edit?: string;
-    };
-}
-interface IdField extends BaseFieldConfig {
-    type: 'id';
-}
-interface TextField extends BaseFieldConfig {
-    type: 'text';
-    maxLength?: number;
-    minLength?: number;
-    pattern?: RegExp;
-}
-interface NumberField extends BaseFieldConfig {
-    type: 'number';
-    min?: number;
-    max?: number;
-    integer?: boolean;
-}
-interface BooleanField extends BaseFieldConfig {
-    type: 'boolean';
-}
-interface DateField extends BaseFieldConfig {
-    type: 'date';
-    minDate?: Date;
-    maxDate?: Date;
-}
-interface SelectField extends BaseFieldConfig {
-    type: 'select';
-    options: readonly string[];
-}
-interface ReferenceField extends BaseFieldConfig {
-    type: 'reference';
-    entity: string;
-    cardinality: 'one' | 'many';
-    onDelete?: 'cascade' | 'set-null' | 'restrict';
-}
-interface MediaField extends BaseFieldConfig {
-    type: 'media';
-    accept?: string[];
-    maxSize?: number;
-}
-interface RichTextField extends BaseFieldConfig {
-    type: 'richtext';
-    blocks?: string[];
-}
-interface SlugField extends BaseFieldConfig {
-    type: 'slug';
-    from: string;
-    unique?: boolean;
-}
-/**
- * Minimal block definition reference — used by BlocksField to type-check allowed blocks.
- * The full BlockDefinition (with label, etc.) lives in @murumets-ee/content.
- */
-interface BlockDefinitionRef {
-    slug: string;
-    fields: Record<string, FieldConfig>;
-}
-/**
- * Blocks field — ordered array of typed content blocks.
- * Each block instance stores its data in {entity}_layout table.
- *
- * @property blocks - Allowed block definitions
- * @property min/max - Block count constraints
- * @property localized - true = per-locale layouts, false = shared layout with translated content (default)
- */
-interface JsonField extends BaseFieldConfig {
-    type: 'json';
-}
-interface BlocksField extends BaseFieldConfig {
-    type: 'blocks';
-    blocks: readonly BlockDefinitionRef[];
-    min?: number;
-    max?: number;
-    localized?: boolean;
-}
-type FieldConfig = IdField | TextField | NumberField | BooleanField | DateField | SelectField | ReferenceField | MediaField | RichTextField | SlugField | JsonField | BlocksField;
-
-/**
- * Schema-aware reference extraction.
- *
- * Walks entity field definitions and data to find all outgoing references.
- * Handles:
- * - field.media() → target = 'media', single UUID
- * - field.reference() → target = config.entity, single UUID or UUID[]
- * - field.blocks() → inspects block instance data for media/reference fields
- */
-
-interface ExtractedRef {
-    sourceField: string;
-    targetEntity: string;
-    targetId: string;
-}
-/**
- * Extract all outgoing references from entity data.
- *
- * @param allFields - The entity's complete field map (entity.allFields)
- * @param data      - The entity data (full on create, partial on update)
- * @returns Deduplicated array of extracted references
- */
-declare function extractRefs(allFields: Record<string, FieldConfig>, data: Record<string, unknown>): ExtractedRef[];
-/**
- * Get the names of all ref-bearing fields in the entity.
- * Used to scope partial-update ref deletion.
- */
-declare function getRefBearingFields(allFields: Record<string, FieldConfig>): string[];
-
-/**
- * entity_refs — Universal reference tracking table.
- *
- * Every reference between entities (field.media(), field.reference(), block media fields)
- * gets a row here at write time. This enables:
- * - Instant "where is this used?" queries (one indexed lookup)
- * - Universal delete protection (can't delete referenced entities)
- * - Correct results (schema-aware, no LIKE text search)
- */
-declare const entityRefs: drizzle_orm_pg_core.PgTableWithColumns<{
-    name: "entity_refs";
-    schema: undefined;
-    columns: {
-        sourceEntity: drizzle_orm_pg_core.PgColumn<{
-            name: "source_entity";
-            tableName: "entity_refs";
-            dataType: "string";
-            columnType: "PgVarchar";
-            data: string;
-            driverParam: string;
-            notNull: true;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: [string, ...string[]];
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            length: 100;
-        }>;
-        sourceId: drizzle_orm_pg_core.PgColumn<{
-            name: "source_id";
-            tableName: "entity_refs";
-            dataType: "string";
-            columnType: "PgUUID";
-            data: string;
-            driverParam: string;
-            notNull: true;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: undefined;
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {}>;
-        sourceField: drizzle_orm_pg_core.PgColumn<{
-            name: "source_field";
-            tableName: "entity_refs";
-            dataType: "string";
-            columnType: "PgVarchar";
-            data: string;
-            driverParam: string;
-            notNull: true;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: [string, ...string[]];
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            length: 100;
-        }>;
-        targetEntity: drizzle_orm_pg_core.PgColumn<{
-            name: "target_entity";
-            tableName: "entity_refs";
-            dataType: "string";
-            columnType: "PgVarchar";
-            data: string;
-            driverParam: string;
-            notNull: true;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: [string, ...string[]];
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {
-            length: 100;
-        }>;
-        targetId: drizzle_orm_pg_core.PgColumn<{
-            name: "target_id";
-            tableName: "entity_refs";
-            dataType: "string";
-            columnType: "PgUUID";
-            data: string;
-            driverParam: string;
-            notNull: true;
-            hasDefault: false;
-            isPrimaryKey: false;
-            isAutoincrement: false;
-            hasRuntimeDefault: false;
-            enumValues: undefined;
-            baseColumn: never;
-            identity: undefined;
-            generated: undefined;
-        }, {}, {}>;
-    };
-    dialect: "pg";
-}>;
-
-export { type EntityUsage, type ExtractedRef, ReferencedEntityError, entityRefs, extractRefs, findEntityUsages, getRefBearingFields };

package/dist/refs/index.js

@@ -1 +0,0 @@
-var p=class extends Error{entityName;entityId;usages;constructor(i,s,r){let o=r.length;super(`Cannot delete ${i} '${s}': referenced by ${o} other entit${o===1?"y":"ies"}`),this.name="ReferencedEntityError",this.entityName=i,this.entityId=s,this.usages=r}};var h=/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;function I(e,i){let s=[],r=new Set;function o(n,d,t){if(!h.test(t))return;let c=`${n}|${d}|${t}`;r.has(c)||(r.add(c),s.push({sourceField:n,targetEntity:d,targetId:t}))}for(let[n,d]of Object.entries(e)){let t=i[n];if(t!=null)switch(d.type){case"media":{typeof t=="string"&&o(n,"media",t);break}case"reference":{let c=d;if(c.cardinality==="many"&&Array.isArray(t))for(let g of t)typeof g=="string"&&o(n,c.entity,g);else typeof t=="string"&&o(n,c.entity,t);break}case"blocks":{let c=d;if(!Array.isArray(t))break;for(let g of t){let b=g,E=b._block;if(!E)continue;let x=c.blocks.find(l=>l.slug===E);if(x)for(let[l,y]of Object.entries(x.fields)){let a=b[l];if(a!=null&&(y.type==="media"&&typeof a=="string"&&o(n,"media",a),y.type==="reference")){let u=y;if(u.cardinality==="many"&&Array.isArray(a))for(let k of a)typeof k=="string"&&o(n,u.entity,k);else typeof a=="string"&&o(n,u.entity,a)}}}break}}}return s}function U(e){let i=[];for(let[s,r]of Object.entries(e))(r.type==="media"||r.type==="reference"||r.type==="blocks")&&i.push(s);return i}import{and as w,eq as _}from"drizzle-orm";import{index as R,pgTable as N,unique as j,uuid as F,varchar as m}from"drizzle-orm/pg-core";var f=N("entity_refs",{sourceEntity:m("source_entity",{length:100}).notNull(),sourceId:F("source_id").notNull(),sourceField:m("source_field",{length:100}).notNull(),targetEntity:m("target_entity",{length:100}).notNull(),targetId:F("target_id").notNull()},e=>[j("uq_entity_refs").on(e.sourceEntity,e.sourceId,e.sourceField,e.targetEntity,e.targetId),R("idx_entity_refs_target").on(e.targetEntity,e.targetId),R("idx_entity_refs_source").on(e.sourceEntity,e.sourceId)]);async function C(e,i,s){return await s.select({sourceEntity:f.sourceEntity,sourceId:f.sourceId,sourceField:f.sourceField}).from(f).where(w(_(f.targetEntity,e),_(f.targetId,i)))}export{p as ReferencedEntityError,f as entityRefs,I as extractRefs,C as findEntityUsages,U as getRefBearingFields};