@happyvertical/smrt-properties 0.51.31 → 0.51.33

package/dist/index.d.ts

@@ -1,445 +1,68 @@
-import { PromptDefinition } from '@happyvertical/smrt-prompts';
-import { ResolvedPromptAI } from '@happyvertical/smrt-prompts';
-import { SmrtCollection } from '@happyvertical/smrt-core';
-import { SmrtHierarchical } from '@happyvertical/smrt-core';
-import { SmrtObject } from '@happyvertical/smrt-core';
-import { SmrtObjectOptions } from '@happyvertical/smrt-core';
-
-export declare function promptMessageOptions(ai: ResolvedPromptAI): {
-    maxTokens?: number | undefined;
-    temperature?: number | undefined;
-    model?: string | undefined;
-};
-
-export declare class Property extends SmrtObject {
-    /**
-     * Tenant ID for multi-tenant isolation
-     */
-    tenantId: string | null;
-    /**
-     * Display name of the property
-     */
-    name: string;
-    /**
-     * Domain name (e.g., "oakcreeknews.com")
-     */
-    domain: string;
-    /**
-     * Full URL (e.g., "https://oakcreeknews.com")
-     */
-    url: string;
-    /**
-     * Property description
-     */
-    description: string;
-    /**
-     * Link to Repository (from smrt-projects)
-     * Optional - used when property is backed by a git repository
-     */
-    repositoryId: string | null;
-    /**
-     * Link to Profile (from smrt-profiles)
-     * Optional - owner/publisher of the property
-     */
-    ownerId: string | null;
-    /**
-     * Property status
-     */
-    status: PropertyStatus;
-    /**
-     * Extensible metadata (analytics IDs, config, etc.)
-     */
-    metadata: Record<string, unknown>;
-    constructor(options?: PropertyOptions);
-    /**
-     * Get all zones for this property
-     */
-    getZones(): Promise< Zone[]>;
-    /**
-     * Get zone tree for this property
-     */
-    getZoneTree(): Promise< ZoneTree<Zone>>;
-    /**
-     * Create a zone on this property
-     */
-    createZone(options: Omit< ZoneOptions, 'propertyId'>): Promise< Zone>;
-    /**
-     * Check if property is active
-     */
-    isActive(): boolean;
-    /**
-     * AI-powered: Generate a summary of the property and its zones.
-     *
-     * Uses the `smrtProperties.property.summarize` prompt registered via
-     * `@happyvertical/smrt-prompts`, allowing tenant- or instance-level
-     * overrides of the template, model, and parameters at runtime.
-     *
-     * Only non-PII fields (name, domain, description, status) plus aggregate
-     * zone information are sent to the AI provider. Internal foreign-key
-     * fields and the extensible `metadata` blob are intentionally excluded.
-     *
-     * @returns Generated summary text
-     */
-    summarize(): Promise<string>;
-}
-
-export declare class PropertyCollection extends SmrtCollection<Property> {
-    static readonly _itemClass: typeof Property;
-    /**
-     * Find a property by domain
-     *
-     * @param domain - Domain name
-     * @returns Property or null
-     */
-    findByDomain(domain: string): Promise<Property | null>;
-    /**
-     * Find properties by repository ID
-     *
-     * @param repositoryId - Repository ID
-     * @returns Array of properties
-     */
-    findByRepository(repositoryId: string): Promise<Property[]>;
-    /**
-     * Find properties by owner ID
-     *
-     * @param ownerId - Owner profile ID
-     * @returns Array of properties
-     */
-    findByOwner(ownerId: string): Promise<Property[]>;
-    /**
-     * Find active properties
-     *
-     * @returns Array of active properties
-     */
-    findActive(): Promise<Property[]>;
-    /**
-     * Find properties by status
-     *
-     * @param status - Property status
-     * @returns Array of properties with the given status
-     */
-    findByStatus(status: PropertyStatus): Promise<Property[]>;
-    /**
-     * Get or create a property by domain
-     *
-     * @param domain - Domain name
-     * @param defaults - Default values for creation
-     * @returns Property (existing or newly created)
-     */
-    getOrCreateByDomain(domain: string, defaults?: {
-        name?: string;
-        url?: string;
-        repositoryId?: string | null;
-        ownerId?: string | null;
-    }): Promise<Property>;
-    /**
-     * Count properties by status
-     *
-     * @returns Object with counts per status
-     */
-    countByStatus(): Promise<Record<PropertyStatus, number>>;
-    /**
-     * Find properties belonging to a specific tenant
-     *
-     * @param tenantId - Tenant ID to filter by
-     * @returns Array of properties for the tenant
-     */
-    findByTenant(tenantId: string): Promise<Property[]>;
-    /**
-     * Find all global properties (no tenant association).
-     *
-     * Routes through the shared tenant-global helper so it does not throw under
-     * an active tenant context (an explicit `tenant_id IS NULL` filter would be
-     * flagged as an isolation violation). (#1600)
-     *
-     * @returns Array of global properties
-     */
-    findGlobal(): Promise<Property[]>;
-    /**
-     * Find properties for a tenant plus all global properties.
-     *
-     * Fails closed if an active tenant context requests a different tenant's
-     * rows; the admin/system path keeps the cross-tenant capability. (#1600)
-     *
-     * @param tenantId - Tenant ID to filter by
-     * @returns Array of tenant-specific and global properties
-     */
-    findWithGlobals(tenantId: string): Promise<Property[]>;
-}
-
-/**
- * Options for creating a Property instance
- */
-export declare interface PropertyOptions extends SmrtObjectOptions {
-    tenantId?: string | null;
-    name?: string;
-    domain?: string;
-    url?: string;
-    description?: string;
-    repositoryId?: string | null;
-    ownerId?: string | null;
-    status?: PropertyStatus;
-    metadata?: Record<string, unknown>;
-}
-
-/**
- * Status of a digital property
- */
-export declare type PropertyStatus = 'active' | 'inactive' | 'pending';
-
-export declare const smrtPropertiesSummarizePrompt: PromptDefinition;
-
-export declare class Zone extends SmrtHierarchical {
-    /**
-     * Tenant ID for multi-tenant isolation
-     */
-    tenantId: string | null;
-    /**
-     * Parent property ID (required)
-     */
-    propertyId: string;
-    /**
-     * Display name
-     */
-    name: string;
-    /**
-     * Zone type (descriptive, not structural)
-     * Common values: "page", "section", "slot", "container", "widget"
-     */
-    type: string;
-    /**
-     * URL path pattern (e.g., "/", "/articles/*")
-     */
-    path: string;
-    /**
-     * CSS selector for placement (e.g., "#header", ".sidebar")
-     */
-    selector: string;
-    /**
-     * Position hint (e.g., "top", "after-paragraph-3")
-     */
-    position: string;
-    /**
-     * Width in pixels (null = fluid)
-     */
-    width: number | null;
-    /**
-     * Height in pixels (null = fluid)
-     */
-    height: number | null;
-    /**
-     * Allowed content/ad formats
-     */
-    allowedFormats: string[];
-    /**
-     * Default content/asset ID for fallback
-     */
-    defaultContentId: string | null;
-    /**
-     * Extensible metadata
-     */
-    metadata: Record<string, unknown>;
-    constructor(options?: ZoneOptions);
-    /**
-     * Check if this is a top-level zone (no parent)
-     */
-    isTopLevel(): boolean;
-    /**
-     * Check if this zone has dimensions set
-     */
-    hasDimensions(): boolean;
-    /**
-     * Get dimensions as string (e.g., "728x90")
-     */
-    getDimensionString(): string | null;
-    /**
-     * Get the parent property
-     */
-    getProperty(): Promise< Property | null>;
-    /**
-     * Get the full path from root to this zone
-     */
-    getFullPath(): Promise<string>;
-    /**
-     * Get the depth in the hierarchy (0 = top-level)
-     */
-    getDepth(): Promise<number>;
-    /**
-     * Create a child zone under this zone
-     */
-    createChild(options: Omit<ZoneOptions, 'propertyId' | 'parentId'>): Promise<Zone>;
-    /**
-     * Build tree node for this zone and its children
-     */
-    toTreeNode(): Promise<ZoneTreeNode<Zone>>;
-    /**
-     * Check if a format is allowed in this zone
-     */
-    isFormatAllowed(format: string): boolean;
-}
-
-export declare class ZoneCollection extends SmrtCollection<Zone> {
-    static readonly _itemClass: typeof Zone;
-    /**
-     * Find all zones for a property
-     *
-     * @param propertyId - Property ID
-     * @returns Array of zones
-     */
-    findByProperty(propertyId: string): Promise<Zone[]>;
-    /**
-     * Find top-level zones for a property (no parent)
-     *
-     * @param propertyId - Property ID
-     * @returns Array of top-level zones
-     */
-    findTopLevel(propertyId: string): Promise<Zone[]>;
-    /**
-     * Find direct children of a zone
-     *
-     * @param parentId - Parent zone ID
-     * @returns Array of child zones
-     */
-    findChildren(parentId: string): Promise<Zone[]>;
-    /**
-     * Find zones by path pattern
-     *
-     * @param propertyId - Property ID
-     * @param path - URL path to match
-     * @returns Array of matching zones
-     */
-    findByPath(propertyId: string, path: string): Promise<Zone[]>;
-    /**
-     * Find zones by type
-     *
-     * @param propertyId - Property ID
-     * @param type - Zone type
-     * @returns Array of zones of the given type
-     */
-    findByType(propertyId: string, type: string): Promise<Zone[]>;
-    /**
-     * Get the complete zone tree for a property
-     *
-     * @param propertyId - Property ID
-     * @returns ZoneTree structure
-     */
-    getTree(propertyId: string): Promise<ZoneTree<Zone>>;
-    /**
-     * Get all ancestors of a zone (path to root)
-     *
-     * @param zoneId - Zone ID
-     * @returns Array of ancestors (from root to parent)
-     */
-    getAncestors(zoneId: string): Promise<Zone[]>;
-    /**
-     * Get all descendants of a zone recursively
-     *
-     * @param zoneId - Zone ID
-     * @returns Array of all descendant zones
-     */
-    getDescendants(zoneId: string): Promise<Zone[]>;
-    /**
-     * Get the depth of the deepest zone in a property
-     *
-     * @param propertyId - Property ID
-     * @returns Maximum depth (0 = only top-level zones)
-     */
-    getMaxDepth(propertyId: string): Promise<number>;
-    /**
-     * Find zones with specific dimensions
-     *
-     * @param propertyId - Property ID
-     * @param width - Required width
-     * @param height - Required height
-     * @returns Array of matching zones
-     */
-    findByDimensions(propertyId: string, width: number, height: number): Promise<Zone[]>;
-    /**
-     * Find zones that allow a specific format
-     *
-     * @param propertyId - Property ID
-     * @param format - Format to check
-     * @returns Array of zones allowing the format
-     */
-    findByAllowedFormat(propertyId: string, format: string): Promise<Zone[]>;
-    /**
-     * Move a zone to a new parent
-     *
-     * @param zoneId - Zone ID to move
-     * @param newParentId - New parent ID (null for top-level)
-     * @returns Updated zone
-     */
-    moveZone(zoneId: string, newParentId: string | null): Promise<Zone | null>;
-    /**
-     * Delete a zone and optionally its descendants
-     *
-     * @param zoneId - Zone ID to delete
-     * @param cascade - Whether to delete descendants
-     * @returns Number of zones deleted
-     */
-    deleteZone(zoneId: string, cascade?: boolean): Promise<number>;
-    /**
-     * Find zones belonging to a specific tenant
-     *
-     * @param tenantId - Tenant ID to filter by
-     * @returns Array of zones for the tenant
-     */
-    findByTenant(tenantId: string): Promise<Zone[]>;
-    /**
-     * Find all global zones (no tenant association).
-     *
-     * Routes through the shared tenant-global helper so it does not throw under
-     * an active tenant context (an explicit `tenant_id IS NULL` filter would be
-     * flagged as an isolation violation). (#1600)
-     *
-     * @returns Array of global zones
-     */
-    findGlobal(): Promise<Zone[]>;
-    /**
-     * Find zones for a tenant plus all global zones.
-     *
-     * Fails closed if an active tenant context requests a different tenant's
-     * rows; the admin/system path keeps the cross-tenant capability. (#1600)
-     *
-     * @param tenantId - Tenant ID to filter by
-     * @returns Array of tenant-specific and global zones
-     */
-    findWithGlobals(tenantId: string): Promise<Zone[]>;
-}
-
-/**
- * Options for creating a Zone instance
- */
-export declare interface ZoneOptions extends SmrtObjectOptions {
-    tenantId?: string | null;
-    propertyId?: string;
-    parentId?: string | null;
-    name?: string;
-    type?: string;
-    path?: string;
-    selector?: string;
-    position?: string;
-    width?: number | null;
-    height?: number | null;
-    allowedFormats?: string[];
-    defaultContentId?: string | null;
-    metadata?: Record<string, unknown>;
-}
-
-/**
- * Complete zone tree for a property
- */
-export declare interface ZoneTree<T = unknown> {
-    propertyId: string;
-    roots: ZoneTreeNode<T>[];
-}
-
-/**
- * A node in the zone tree hierarchy
- */
-export declare interface ZoneTreeNode<T = unknown> {
-    zone: T;
-    children: ZoneTreeNode<T>[];
-}
-
-export { }
+/**
+ * @happyvertical/smrt-properties
+ *
+ * Digital property and zone management for the SMRT framework.
+ *
+ * This package provides models for managing digital properties (websites, apps)
+ * and their hierarchical zones (pages, sections, slots).
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   Property,
+ *   PropertyCollection,
+ *   Zone,
+ *   ZoneCollection
+ * } from '@happyvertical/smrt-properties';
+ *
+ * // Create collections
+ * const properties = await PropertyCollection.create({
+ *   db: { type: 'sqlite', url: 'properties.db' }
+ * });
+ * const zones = await ZoneCollection.create({
+ *   db: { type: 'sqlite', url: 'properties.db' }
+ * });
+ *
+ * // Create a property
+ * const site = await properties.create({
+ *   name: 'Oak Creek News',
+ *   domain: 'oakcreeknews.com',
+ *   url: 'https://oakcreeknews.com',
+ *   status: 'active'
+ * });
+ * await site.save();
+ *
+ * // Create hierarchical zones (IDs are guaranteed after save())
+ * const homePage = await zones.create({
+ *   propertyId: site.id!,
+ *   name: 'Home Page',
+ *   type: 'page',
+ *   path: '/'
+ * });
+ * await homePage.save();
+ *
+ * const headerSlot = await zones.create({
+ *   propertyId: site.id!,
+ *   parentId: homePage.id!,
+ *   name: 'Header Leaderboard',
+ *   type: 'slot',
+ *   width: 728,
+ *   height: 90
+ * });
+ * await headerSlot.save();
+ *
+ * // Get zone tree
+ * const tree = await zones.getTree(site.id!);
+ * ```
+ *
+ * @packageDocumentation
+ */
+import './__smrt-register__.js';
+import './prompts.js';
+export { PropertyCollection } from './collections/Properties';
+export { ZoneCollection } from './collections/Zones';
+export { Property } from './models/Property';
+export { Zone } from './models/Zone';
+export { promptMessageOptions, smrtPropertiesSummarizePrompt, } from './prompts';
+export type { PropertyOptions, PropertyStatus, ZoneOptions, ZoneTree, ZoneTreeNode, } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AAKH,OAAO,wBAAwB,CAAC;AAGhC,OAAO,cAAc,CAAC;AAGtB,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAIrC,OAAO,EACL,oBAAoB,EACpB,6BAA6B,GAC9B,MAAM,WAAW,CAAC;AAGnB,YAAY,EACV,eAAe,EACf,cAAc,EACd,WAAW,EACX,QAAQ,EACR,YAAY,GACb,MAAM,SAAS,CAAC"}