@blocksdiy/blocks-client-sdk 1.0.0

package/dist/Entity.d.ts

@@ -0,0 +1,299 @@
+/**
+ * Base entity properties automatically included in all entity instances
+ * These system fields are managed by the backend and available on all entities
+ * @interface BaseEntityType
+ */
+export interface BaseEntityType {
+    /** Unique identifier for the entity */
+    id: string;
+    /** ISO timestamp of when the entity was created */
+    createdAt: string;
+    /** ISO timestamp of when the entity was last updated */
+    updatedAt: string;
+    /** ID of the user who created the entity */
+    createdBy: string;
+    /** ID of the user who last updated the entity */
+    updatedBy: string;
+    /** ID of the agent that last updated the entity (if applicable) */
+    updatedByAgentId: string;
+}
+/**
+ * Configuration for defining an entity type
+ *
+ * This interface is used to define the structure and mapping of an entity,
+ * connecting frontend property names to database column names.
+ *
+ * @interface EntityConfig
+ * @template T - Type defining the structure of the entity instance
+ * @property {string} tableBlockId - Unique identifier for the table where the entity is stored
+ * @property {T} instanceType - Type definition object for the entity's structure
+ */
+export interface EntityConfig<T extends Record<string, unknown> = {}> {
+    tableBlockId: string;
+    instanceType: T;
+}
+/**
+ * Type representing only the mutable fields of an entity
+ * Used for creating or updating entities with user-defined fields only
+ */
+export type EntityTypeOnlyMutable<E extends EntityConfig> = E["instanceType"];
+/**
+ * Type representing the complete entity with system and user-defined fields
+ * This is the standard format used in the frontend application
+ */
+export type EntityType<E extends EntityConfig> = BaseEntityType & EntityTypeOnlyMutable<E>;
+/**
+ * Entity class for performing CRUD operations on data entities
+ *
+ * This class provides methods to create, read, update, and delete entity records,
+ * handling the mapping between frontend property names and database column names.
+ *
+ * @class Entity
+ * @template EC - Entity configuration type
+ */
+export declare class Entity<EC extends EntityConfig = EntityConfig> {
+    private tableBlockId;
+    private dataApiService;
+    /**
+     * Creates a new Entity instance
+     * @param {EC} config - Configuration for the entity
+     * @param {string} token - The token for the application
+     */
+    constructor(config: EC, { token }?: {
+        token?: string;
+    });
+    /**
+     * Retrieves a single entity by filters
+     *
+     * Fetches an entity from the database and transforms it to the frontend format
+     * with properly mapped property names.
+     *
+     * @param {Record<string, any>} filters - Filters to identify the entity (e.g., { id: "123" } or { email: "user@example.com" })
+     * @returns {Promise<EntityType<EC> | null>} The entity if found, null otherwise
+     * @example
+     * ```ts
+     * // Define a user entity configuration
+     * const userConfig = {
+     *   tableBlockId: 'users-table',
+     *   instanceType: {} as {
+     *     name: string;
+     *     email: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const userEntity = new Entity(userConfig);
+     *
+     * // Find a user by email
+     * const user = await userEntity.findOne({ email: 'user@example.com' });
+     * if (user) {
+     *   console.log(`Found user: ${user.name}, email: ${user.email}`);
+     * }
+     * ```
+     */
+    findOne(filters: Record<string, any>): Promise<EntityType<EC> | null>;
+    /**
+     * Retrieves multiple entities that match the provided filters
+     *
+     * Fetches entities from the database and transforms them to the frontend format
+     * with properly mapped property names.
+     *
+     * @param {any} [filters] - Optional filters to apply to the query
+     * @returns {Promise<Array<EntityType<EC>>>} Array of matching entities
+     * @example
+     * ```ts
+     * // Define a product entity configuration
+     * const productConfig = {
+     *   tableBlockId: 'products-table',
+     *   instanceType: {} as {
+     *     name: string;
+     *     price: number;
+     *     category: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const productEntity = new Entity(productConfig);
+     *
+     * // Find all products in a specific category
+     * const products = await productEntity.findMany({ category: 'electronics' });
+     *
+     * // Process the results
+     * products.forEach(product => {
+     *   console.log(`${product.name}: $${product.price}`);
+     * });
+     * ```
+     */
+    findMany(filters?: any): Promise<any[]>;
+    /**
+     * Creates a new entity in the database
+     *
+     * Transforms the provided data to the database format with column name mapping
+     * and inserts it into the database.
+     *
+     * @param {EntityTypeOnlyMutable<EC>} data - The entity data to create
+     * @returns {Promise<EntityType<EC>>} The created entity with system fields
+     * @example
+     * ```ts
+     * // Define a task entity configuration
+     * const taskConfig = {
+     *   tableBlockId: 'tasks-table',
+     *   instanceType: {} as {
+     *     title: string;
+     *     description: string;
+     *     status: 'todo' | 'in_progress' | 'done';
+     *     assigneeId: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const taskEntity = new Entity(taskConfig);
+     *
+     * // Create a new task
+     * const newTask = await taskEntity.create({
+     *   title: 'Implement feature X',
+     *   description: 'Add the new feature with tests',
+     *   status: 'todo',
+     *   assigneeId: 'user-456'
+     * });
+     *
+     * console.log(`Created task with ID: ${newTask.id}`);
+     * ```
+     */
+    create(data: EntityTypeOnlyMutable<EC>): Promise<EntityType<EC>>;
+    /**
+     * Creates multiple new entities in the database
+     *
+     * Transforms the provided array of data to the database format with column name mapping
+     * and inserts them into the database in a single operation.
+     *
+     * @param {EntityTypeOnlyMutable<EC>[]} data - Array of entity data to create
+     * @returns {Promise<EntityType<EC>[]>} Array of created entities with system fields
+     * @example
+     * ```ts
+     * // Define a task entity configuration
+     * const taskConfig = {
+     *   tableBlockId: 'tasks-table',
+     *   instanceType: {} as {
+     *     title: string;
+     *     description: string;
+     *     status: 'todo' | 'in_progress' | 'done';
+     *     assigneeId: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const taskEntity = new Entity(taskConfig);
+     *
+     * // Create multiple tasks at once
+     * const newTasks = await taskEntity.createMany([
+     *   {
+     *     title: 'Implement feature X',
+     *     description: 'Add the new feature with tests',
+     *     status: 'todo',
+     *     assigneeId: 'user-456'
+     *   },
+     *   {
+     *     title: 'Review pull requests',
+     *     description: 'Review pending PRs',
+     *     status: 'in_progress',
+     *     assigneeId: 'user-789'
+     *   }
+     * ]);
+     *
+     * console.log(`Created ${newTasks.length} tasks`);
+     * ```
+     */
+    createMany(data: EntityTypeOnlyMutable<EC>[]): Promise<EntityType<EC>[]>;
+    /**
+     * Updates an existing entity in the database
+     *
+     * Transforms the provided data to the database format with column name mapping
+     * and updates the specified entity in the database.
+     *
+     * @param {string} rowId - The ID of the entity to update
+     * @param {Partial<EntityTypeOnlyMutable<EC>>} data - The partial entity data to update
+     * @returns {Promise<EntityType<EC>>} The updated entity
+     * @example
+     * ```ts
+     * // Define a user entity configuration
+     * const userConfig = {
+     *   tableBlockId: 'users-table',
+     *   instanceType: {} as {
+     *     name: string;
+     *     email: string;
+     *     role: string;
+     *     lastLogin: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const userEntity = new Entity(userConfig);
+     *
+     * // Update a user's role
+     * const updatedUser = await userEntity.updateOne('8', {
+     *   role: 'admin',
+     *   lastLogin: new Date().toISOString()
+     * });
+     *
+     * console.log(`Updated user ${updatedUser.name}'s role to ${updatedUser.role}`);
+     * ```
+     */
+    updateOne(rowId: string, data: Partial<EntityTypeOnlyMutable<EC>>): Promise<EntityType<EC>>;
+    /**
+     * Deletes an entity from the database
+     *
+     * @param {string} id - The ID of the entity to delete
+     * @returns {Promise<void>}
+     * @example
+     * ```ts
+     * // Define a comment entity configuration
+     * const commentConfig = {
+     *   tableBlockId: 'comments-table',
+     *   instanceType: {} as {
+     *     text: string;
+     *     postId: string;
+     *     authorId: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const commentEntity = new Entity(commentConfig);
+     *
+     * // Delete a comment
+     * await commentEntity.deleteOne('comment-456');
+     * console.log('Comment deleted successfully');
+     * ```
+     */
+    deleteOne(id: string): Promise<void>;
+    /**
+     * Deletes multiple entities from the database
+     *
+     * Processes deletions in chunks to handle large arrays efficiently,
+     * executing multiple deletion operations in parallel when needed.
+     *
+     * @param {string[]} ids - Array of entity IDs to delete
+     * @returns {Promise<void>}
+     * @example
+     * ```ts
+     * // Define a comment entity configuration
+     * const commentConfig = {
+     *   tableBlockId: 'comments-table',
+     *   instanceType: {} as {
+     *     text: string;
+     *     postId: string;
+     *     authorId: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const commentEntity = new Entity(commentConfig);
+     *
+     * // Delete multiple comments at once
+     * await commentEntity.deleteMany(['comment-123', 'comment-456', 'comment-789']);
+     * console.log('Comments deleted successfully');
+     * ```
+     */
+    deleteMany(ids: string[]): Promise<void>;
+}
+//# sourceMappingURL=Entity.d.ts.map

package/dist/Entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.d.ts","sourceRoot":"","sources":["../src/Entity.ts"],"names":[],"mappings":"AAaA;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,mEAAmE;IACnE,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE;IAClE,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,CAAC,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,YAAY,IAAI,CAAC,CAAC,cAAc,CAAC,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,YAAY,IAAI,cAAc,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC;AAE3F;;;;;;;;GAQG;AACH,qBAAa,MAAM,CAAC,EAAE,SAAS,YAAY,GAAG,YAAY;IACxD,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,cAAc,CAAiB;IAEvC;;;;OAIG;gBACS,MAAM,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO;IAK1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAU1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG;IAY5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,MAAM,CAAC,IAAI,EAAE,qBAAqB,CAAC,EAAE,CAAC;IAU5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,UAAU,CAAC,IAAI,EAAE,qBAAqB,CAAC,EAAE,CAAC,EAAE;IAUlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;IAUvE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM;IAS1B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE;CAS/B"}

package/dist/Entity.js

@@ -0,0 +1,329 @@
+import { DataApiService } from "@blockscom/blocks-client-api";
+const DATA_OPERATIONS_CHUNK_SIZE = 500;
+const arrayToChunks = (array, chunkSize) => {
+    const chunks = [];
+    for (let i = 0; i < array.length; i += chunkSize) {
+        chunks.push(array.slice(i, i + chunkSize));
+    }
+    return chunks;
+};
+/**
+ * Entity class for performing CRUD operations on data entities
+ *
+ * This class provides methods to create, read, update, and delete entity records,
+ * handling the mapping between frontend property names and database column names.
+ *
+ * @class Entity
+ * @template EC - Entity configuration type
+ */
+export class Entity {
+    tableBlockId;
+    dataApiService;
+    /**
+     * Creates a new Entity instance
+     * @param {EC} config - Configuration for the entity
+     * @param {string} token - The token for the application
+     */
+    constructor(config, { token } = {}) {
+        this.tableBlockId = config.tableBlockId;
+        this.dataApiService = new DataApiService({ token });
+    }
+    /**
+     * Retrieves a single entity by filters
+     *
+     * Fetches an entity from the database and transforms it to the frontend format
+     * with properly mapped property names.
+     *
+     * @param {Record<string, any>} filters - Filters to identify the entity (e.g., { id: "123" } or { email: "user@example.com" })
+     * @returns {Promise<EntityType<EC> | null>} The entity if found, null otherwise
+     * @example
+     * ```ts
+     * // Define a user entity configuration
+     * const userConfig = {
+     *   tableBlockId: 'users-table',
+     *   instanceType: {} as {
+     *     name: string;
+     *     email: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const userEntity = new Entity(userConfig);
+     *
+     * // Find a user by email
+     * const user = await userEntity.findOne({ email: 'user@example.com' });
+     * if (user) {
+     *   console.log(`Found user: ${user.name}, email: ${user.email}`);
+     * }
+     * ```
+     */
+    async findOne(filters) {
+        try {
+            const instance = (await this.dataApiService.getTableRow(this.tableBlockId, filters));
+            return instance;
+        }
+        catch (error) {
+            console.warn(error);
+            return null;
+        }
+    }
+    /**
+     * Retrieves multiple entities that match the provided filters
+     *
+     * Fetches entities from the database and transforms them to the frontend format
+     * with properly mapped property names.
+     *
+     * @param {any} [filters] - Optional filters to apply to the query
+     * @returns {Promise<Array<EntityType<EC>>>} Array of matching entities
+     * @example
+     * ```ts
+     * // Define a product entity configuration
+     * const productConfig = {
+     *   tableBlockId: 'products-table',
+     *   instanceType: {} as {
+     *     name: string;
+     *     price: number;
+     *     category: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const productEntity = new Entity(productConfig);
+     *
+     * // Find all products in a specific category
+     * const products = await productEntity.findMany({ category: 'electronics' });
+     *
+     * // Process the results
+     * products.forEach(product => {
+     *   console.log(`${product.name}: $${product.price}`);
+     * });
+     * ```
+     */
+    async findMany(filters) {
+        try {
+            const response = await this.dataApiService.getTableData(this.tableBlockId, filters);
+            // Ensure we're working with an array
+            const instances = Array.isArray(response) ? response : response ? [response] : [];
+            return instances;
+        }
+        catch (error) {
+            console.warn(error);
+            throw error;
+        }
+    }
+    /**
+     * Creates a new entity in the database
+     *
+     * Transforms the provided data to the database format with column name mapping
+     * and inserts it into the database.
+     *
+     * @param {EntityTypeOnlyMutable<EC>} data - The entity data to create
+     * @returns {Promise<EntityType<EC>>} The created entity with system fields
+     * @example
+     * ```ts
+     * // Define a task entity configuration
+     * const taskConfig = {
+     *   tableBlockId: 'tasks-table',
+     *   instanceType: {} as {
+     *     title: string;
+     *     description: string;
+     *     status: 'todo' | 'in_progress' | 'done';
+     *     assigneeId: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const taskEntity = new Entity(taskConfig);
+     *
+     * // Create a new task
+     * const newTask = await taskEntity.create({
+     *   title: 'Implement feature X',
+     *   description: 'Add the new feature with tests',
+     *   status: 'todo',
+     *   assigneeId: 'user-456'
+     * });
+     *
+     * console.log(`Created task with ID: ${newTask.id}`);
+     * ```
+     */
+    async create(data) {
+        try {
+            const [newInstance] = (await this.dataApiService.insertTableRow(this.tableBlockId, data));
+            return newInstance;
+        }
+        catch (error) {
+            console.warn(error);
+            throw error;
+        }
+    }
+    /**
+     * Creates multiple new entities in the database
+     *
+     * Transforms the provided array of data to the database format with column name mapping
+     * and inserts them into the database in a single operation.
+     *
+     * @param {EntityTypeOnlyMutable<EC>[]} data - Array of entity data to create
+     * @returns {Promise<EntityType<EC>[]>} Array of created entities with system fields
+     * @example
+     * ```ts
+     * // Define a task entity configuration
+     * const taskConfig = {
+     *   tableBlockId: 'tasks-table',
+     *   instanceType: {} as {
+     *     title: string;
+     *     description: string;
+     *     status: 'todo' | 'in_progress' | 'done';
+     *     assigneeId: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const taskEntity = new Entity(taskConfig);
+     *
+     * // Create multiple tasks at once
+     * const newTasks = await taskEntity.createMany([
+     *   {
+     *     title: 'Implement feature X',
+     *     description: 'Add the new feature with tests',
+     *     status: 'todo',
+     *     assigneeId: 'user-456'
+     *   },
+     *   {
+     *     title: 'Review pull requests',
+     *     description: 'Review pending PRs',
+     *     status: 'in_progress',
+     *     assigneeId: 'user-789'
+     *   }
+     * ]);
+     *
+     * console.log(`Created ${newTasks.length} tasks`);
+     * ```
+     */
+    async createMany(data) {
+        try {
+            const newInstances = (await this.dataApiService.insertTableRows(this.tableBlockId, data));
+            return newInstances;
+        }
+        catch (error) {
+            console.warn(error);
+            throw error;
+        }
+    }
+    /**
+     * Updates an existing entity in the database
+     *
+     * Transforms the provided data to the database format with column name mapping
+     * and updates the specified entity in the database.
+     *
+     * @param {string} rowId - The ID of the entity to update
+     * @param {Partial<EntityTypeOnlyMutable<EC>>} data - The partial entity data to update
+     * @returns {Promise<EntityType<EC>>} The updated entity
+     * @example
+     * ```ts
+     * // Define a user entity configuration
+     * const userConfig = {
+     *   tableBlockId: 'users-table',
+     *   instanceType: {} as {
+     *     name: string;
+     *     email: string;
+     *     role: string;
+     *     lastLogin: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const userEntity = new Entity(userConfig);
+     *
+     * // Update a user's role
+     * const updatedUser = await userEntity.updateOne('8', {
+     *   role: 'admin',
+     *   lastLogin: new Date().toISOString()
+     * });
+     *
+     * console.log(`Updated user ${updatedUser.name}'s role to ${updatedUser.role}`);
+     * ```
+     */
+    async updateOne(rowId, data) {
+        try {
+            const instance = (await this.dataApiService.updateTableRow(this.tableBlockId, rowId, data));
+            return instance;
+        }
+        catch (error) {
+            console.warn(error);
+            throw error;
+        }
+    }
+    /**
+     * Deletes an entity from the database
+     *
+     * @param {string} id - The ID of the entity to delete
+     * @returns {Promise<void>}
+     * @example
+     * ```ts
+     * // Define a comment entity configuration
+     * const commentConfig = {
+     *   tableBlockId: 'comments-table',
+     *   instanceType: {} as {
+     *     text: string;
+     *     postId: string;
+     *     authorId: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const commentEntity = new Entity(commentConfig);
+     *
+     * // Delete a comment
+     * await commentEntity.deleteOne('comment-456');
+     * console.log('Comment deleted successfully');
+     * ```
+     */
+    async deleteOne(id) {
+        try {
+            await this.dataApiService.deleteTableRow(this.tableBlockId, id);
+        }
+        catch (error) {
+            console.warn(error);
+            throw error;
+        }
+    }
+    /**
+     * Deletes multiple entities from the database
+     *
+     * Processes deletions in chunks to handle large arrays efficiently,
+     * executing multiple deletion operations in parallel when needed.
+     *
+     * @param {string[]} ids - Array of entity IDs to delete
+     * @returns {Promise<void>}
+     * @example
+     * ```ts
+     * // Define a comment entity configuration
+     * const commentConfig = {
+     *   tableBlockId: 'comments-table',
+     *   instanceType: {} as {
+     *     text: string;
+     *     postId: string;
+     *     authorId: string;
+     *   }
+     * };
+     *
+     * // Create entity instance
+     * const commentEntity = new Entity(commentConfig);
+     *
+     * // Delete multiple comments at once
+     * await commentEntity.deleteMany(['comment-123', 'comment-456', 'comment-789']);
+     * console.log('Comments deleted successfully');
+     * ```
+     */
+    async deleteMany(ids) {
+        try {
+            const idsChunks = arrayToChunks(ids, DATA_OPERATIONS_CHUNK_SIZE);
+            await Promise.all(idsChunks.map((idsChunk) => this.dataApiService.deleteTableRows(this.tableBlockId, idsChunk)));
+        }
+        catch (error) {
+            console.warn(error);
+            throw error;
+        }
+    }
+}
+//# sourceMappingURL=Entity.js.map

package/dist/Entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.js","sourceRoot":"","sources":["../src/Entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAE9D,MAAM,0BAA0B,GAAG,GAAG,CAAC;AAEvC,MAAM,aAAa,GAAG,CAAI,KAAU,EAAE,SAAiB,EAAS,EAAE;IAChE,MAAM,MAAM,GAAU,EAAE,CAAC;IACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,SAAS,EAAE,CAAC;QACjD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAkDF;;;;;;;;GAQG;AACH,MAAM,OAAO,MAAM;IACT,YAAY,CAAS;IACrB,cAAc,CAAiB;IAEvC;;;;OAIG;IACH,YAAY,MAAU,EAAE,EAAE,KAAK,KAAyB,EAAE;QACxD,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,OAAO,CAAC,OAA4B;QACxC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAmB,CAAC;YACvG,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAa;QAC1B,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;YACpF,qCAAqC;YACrC,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAClF,OAAO,SAAS,CAAC;QACnB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,MAAM,CAAC,IAA+B;QAC1C,IAAI,CAAC;YACH,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAqB,CAAC;YAC9G,OAAO,WAAW,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,KAAK,CAAC,UAAU,CAAC,IAAiC;QAChD,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAqB,CAAC;YAC9G,OAAO,YAAY,CAAC;QACtB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,SAAS,CAAC,KAAa,EAAE,IAAwC;QACrE,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,CAAmB,CAAC;YAC9G,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,SAAS,CAAC,EAAU;QACxB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAClE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,UAAU,CAAC,GAAa;QAC5B,IAAI,CAAC;YACH,MAAM,SAAS,GAAG,aAAa,CAAC,GAAG,EAAE,0BAA0B,CAAC,CAAC;YACjE,MAAM,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;QACnH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF"}

package/dist/Page.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Configuration for defining a page
+ *
+ * This interface is used to define the basic structure of a page configuration,
+ * including its unique identifier.
+ *
+ * @interface PageConfig
+ * @property {string} pageBlockId - Unique identifier for the page
+ * @property {string} pageName - Name of the page
+ */
+export interface PageConfig {
+    pageBlockId: string;
+    pageName: string;
+}
+/**
+ * Page class for managing application pages and their URLs
+ *
+ * This class provides methods to work with application pages, including
+ * generating proper URLs and handling URL parameters.
+ *
+ * @class Page
+ * @template PC - Page configuration type
+ */
+export declare class Page<PC extends PageConfig = PageConfig> {
+    private pageBlockId;
+    private pageName;
+    private appId;
+    /**
+     * Creates a new Page instance
+     * @param {PC} config - Configuration for the page
+     * @param {string} appId - The application identifier
+     */
+    constructor(config: PC, appId: string);
+    /**
+     * @deprecated
+     * This method is deprecated and will be removed in a future version.
+     * Use the new routing utilities for URL generation instead.
+     *
+     * Generates a URL for this page, including optional search parameters.
+     *
+     * @param {Record<string, string>} [searchParams={}] - Optional search parameters to append to the URL
+     * @returns {string} The generated URL for the page with the given search parameters
+     */
+    getUrl(searchParams?: Record<string, string>): string;
+    /**
+     * @deprecated
+     * This method is deprecated and will be removed in a future version.
+     * Use a dedicated query parameter parsing utility instead.
+     *
+     * Parses and returns the current URL's search parameters as an object.
+     *
+     * @returns {Record<string, string>} An object representation of the URL search parameters
+     */
+    getParams(): Record<string, string>;
+}
+//# sourceMappingURL=Page.d.ts.map

package/dist/Page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Page.d.ts","sourceRoot":"","sources":["../src/Page.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,qBAAa,IAAI,CAAC,EAAE,SAAS,UAAU,GAAG,UAAU;IAClD,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,KAAK,CAAS;IAEtB;;;;OAIG;gBACS,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM;IAMrC;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM;IAKhD;;;;;;;;OAQG;IACH,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAIpC"}