@cyberismo/data-handler 0.0.15 → 0.0.16

package/dist/containers/project.d.ts

@@ -13,44 +13,42 @@
 */
 import { CardContainer } from './card-container.js';
 import { CalculationEngine } from './project/calculation-engine.js';
-import { type Card, type CardAttachment, CardLocation, type CardListContainer, type CardMetadata, type FetchCardDetails, type MetadataContent, type ModuleContent, type ModuleSetting, type ProjectFetchCardDetails, type ProjectMetadata, type Resource, type ResourceFolderType } from '../interfaces/project-interfaces.js';
+import { type Card, type CardAttachment, CardLocation, type CardListContainer, type CardMetadata, type FetchCardDetails, type MetadataContent, type ModuleContent, type ModuleSetting, type ProjectFetchCardDetails, type ProjectMetadata } from '../interfaces/project-interfaces.js';
 import { ProjectConfiguration } from '../project-settings.js';
 import { ProjectPaths } from './project/project-paths.js';
-import { type ResourceName } from '../utils/resource-utils.js';
-import { ResourcesFrom } from './project/resource-collector.js';
+import { ResourcesFrom } from './project/resource-cache.js';
+import { ResourceHandler } from './project/resource-handler.js';
 import type { Template } from './template.js';
-import { CalculationResource } from '../resources/calculation-resource.js';
-import { CardTypeResource } from '../resources/card-type-resource.js';
-import { FieldTypeResource } from '../resources/field-type-resource.js';
-import { GraphModelResource } from '../resources/graph-model-resource.js';
-import { GraphViewResource } from '../resources/graph-view-resource.js';
-import { LinkTypeResource } from '../resources/link-type-resource.js';
-import { ReportResource } from '../resources/report-resource.js';
-import { TemplateResource } from '../resources/template-resource.js';
-import { WorkflowResource } from '../resources/workflow-resource.js';
 export { ResourcesFrom };
+/**
+ * Options for Project initialization.
+ * autoSave - If project configuration changes are saved automatically. Default true.
+ * watchResourceChanges - If project refresh automatically to filesystem changes. Default false.
+ */
+export interface ProjectOptions {
+    autoSave?: boolean;
+    watchResourceChanges?: boolean;
+}
 /**
  * Represents project folder.
  */
 export declare class Project extends CardContainer {
-    private watchResourceChanges?;
+    private options;
     calculationEngine: CalculationEngine;
-    private createdResources;
     private logger;
     private projectPaths;
-    private resources;
+    private resourceHandler;
     private resourceWatcher;
     private settings;
     private validator;
-    constructor(path: string, watchResourceChanges?: boolean | undefined);
+    constructor(path: string, options?: ProjectOptions);
     private changeParent;
     private findModule;
     private handleAttachmentChange;
     private parentFromPath;
     private removeCachedChildren;
-    private replaceCacheValue;
-    private resourcesOfType;
     private updateCachedChildren;
+    private validateCard;
     /**
      * Populate template cards into the card cache.
      */
@@ -59,12 +57,6 @@ export declare class Project extends CardContainer {
      * Populate both the project cards, and all template cards into card cache.
      */
     protected populateCardsCache(): Promise<void>;
-    /**
-     * Add a given 'resource' to the local resource arrays.
-     * @param resource Resource to add.
-     * @param data JSON data for the resource.
-     */
-    addResource(resource: Resource, data: JSON): void;
     /**
      * Returns all template cards from the project. This includes all module templates' cards.
      * @returns all the template cards from the project
@@ -82,17 +74,6 @@ export declare class Project extends CardContainer {
      * @returns Array of attachments from cards at the specified path
      */
     attachmentsByPath(path: string): CardAttachment[];
-    /**
-     * Returns all the attachments in the template cards.
-     * @returns all the attachments in the template cards.
-     */
-    attachmentsFromTemplates(): Promise<CardAttachment[]>;
-    /**
-     * Returns an array of all the calculation files (*.lp) in the project.
-     * @param from Defines where resources are collected from.
-     * @returns array of all calculation files in the project.
-     */
-    calculations(from?: ResourcesFrom): Promise<Resource[]>;
     /**
      * Returns path to a card's attachment folder.
      * @param cardKey card key
@@ -107,13 +88,6 @@ export declare class Project extends CardContainer {
      * @throws If trying to add attachment to module card, or if attachment is not found
      */
     createCardAttachment(cardKey: string, attachmentName: string, attachmentData: string | Buffer): Promise<void>;
-    /**
-     * Removes an attachment from a card.
-     * @param cardKey The card to remove attachment from
-     * @param fileName The name of the attachment file to remove
-     * @throws if trying to remove module card attachment, or the attachment was not found.
-     */
-    removeCardAttachment(cardKey: string, fileName: string): Promise<void>;
     /**
      * Returns path to a card's folder.
      * @param cardKey card key
@@ -126,12 +100,6 @@ export declare class Project extends CardContainer {
      * @returns Card data to the given card keys
      */
     cardKeysToCards(cardIds: string[]): Card[];
-    /**
-     * Accessor for cards cache.
-     * Used by template container (it needs to access project's cache, not their own instance).
-     * @note Should not be used directly (other than Template).
-     */
-    get cardsCache(): import("./project/card-cache.js").CardCache;
     /**
      * Returns an array of all the cards in the project.
      * @note These are project cards only, by default (unless path dictates otherwise).
@@ -141,25 +109,17 @@ export declare class Project extends CardContainer {
      */
     cards(path?: string, details?: FetchCardDetails): Card[];
     /**
-     * Returns an array of all the card types in the project.
-     * @param from Defines where resources are collected from.
-     * @returns array of all card types in the project.
+     * Accessor for cards cache.
+     * Used by template container (it needs to access project's cache, not their own instance).
+     * @note Should not be used directly (other than Template).
      */
-    cardTypes(from?: ResourcesFrom): Promise<Resource[]>;
+    get cardsCache(): import("./project/card-cache.js").CardCache;
     /**
      * Returns children of a given card; as Card array
      * @param card Parent card to fetch children from
      * @returns children of a given card; as Card array
      */
     childrenCards(card: Card): Card[];
-    /**
-     * Updates all local resources.
-     */
-    collectLocalResources(): void;
-    /**
-     * Updates all imported module resources.
-     */
-    collectModuleResources(): void;
     /**
      * Returns project configuration.
      * @returns project configuration.
@@ -175,18 +135,6 @@ export declare class Project extends CardContainer {
      * Cleanups project when it is being closed.
      */
     dispose(): void;
-    /**
-     * Returns an array of all the field types in the project.
-     * @param from Defines where resources are collected from.
-     * @returns array of all field types in the project.
-     */
-    fieldTypes(from?: ResourcesFrom): Promise<Resource[]>;
-    /**
-     * Finds root of a project
-     * @param path Path where to start looking for the project root.
-     * @returns path to a project root, or empty string.
-     */
-    static findProjectRoot(path: string): Promise<string>;
     /**
      * Returns specific card.
      * @param cardToFind Card key to find
@@ -195,17 +143,11 @@ export declare class Project extends CardContainer {
      */
     findCard(cardToFind: string, details?: ProjectFetchCardDetails): Card;
     /**
-     * Returns an array of all the graph models in the project.
-     * @param from Defines where resources are collected from.
-     * @returns array of all the graph models in the project.
-     */
-    graphModels(from?: ResourcesFrom): Promise<Resource[]>;
-    /**
-     * Returns an array of all the graph views in the project.
-     * @param from Defines where resources are collected from.
-     * @returns array of all the graph views in the project.
+     * Finds root of a project
+     * @param path Path where to start looking for the project root.
+     * @returns path to a project root, or empty string.
      */
-    graphViews(from?: ResourcesFrom): Promise<Resource[]>;
+    static findProjectRoot(path: string): Promise<string>;
     /**
      * When card changes.
      * @param changedCard Card that was changed.
@@ -239,12 +181,6 @@ export declare class Project extends CardContainer {
      * @returns true, if in the given path there is a project; false otherwise
      */
     static isCreated(path: string): boolean;
-    /**
-     * Returns an array of all the link types in the project.
-     * @param from Defines where resources are collected from.
-     * @returns array of all link types in the project.
-     */
-    linkTypes(from?: ResourcesFrom): Promise<Resource[]>;
     /**
      * Returns an array of cards in the project, in the templates or both.
      * Cards don't have content and nor metadata.
@@ -265,11 +201,6 @@ export declare class Project extends CardContainer {
      * @returns module details, or undefined if module cannot be found.
      */
     module(moduleName: string): Promise<ModuleContent | undefined>;
-    /**
-     * Returns list of modules in the project.
-     * @returns list of modules in the project.
-     */
-    modules(): Promise<Resource[]>;
     /**
      * Returns a new unique card key with project prefix (e.g. test_x649it4x).
      * Random part of string will be always 8 characters in base-36 (0-9a-z)
@@ -304,61 +235,28 @@ export declare class Project extends CardContainer {
      */
     get projectPrefix(): string;
     /**
-     * Collects all prefixes used in the project (project's own plus all from modules).
+     * Returns all prefixes used in the project (project's own plus all from imported modules).
      * @returns all prefixes used in the project.
-     * @todo - move the module prefix fetch to resource-collector.
-     *        Make it use cached value that is only changed when  module is removed/imported.
-     */
-    projectPrefixes(): Promise<string[]>;
-    /**
-     * Removes a module from the project
-     * @param module Module (name) to remove.
-     */
-    removeModule(moduleName: string): Promise<void>;
-    /**
-     * Removes a resource from Project.
-     * @param resource Resource to remove.
      */
-    removeResource(resource: Resource): void;
+    projectPrefixes(): string[];
     /**
-     * Array of reports in the project.
-     * @param from Defines where resources are collected from.
-     * @returns array of all reports in the project.
-     */
-    reports(from?: ResourcesFrom): Promise<Resource[]>;
-    /**
-     * Returns handlebar files from reports.
-     * @param from Defines where report handlebar files are collected from.
-     * @returns handlebar files from reports.
-     */
-    reportHandlerBarFiles(from?: ResourcesFrom): Promise<string[]>;
-    /**
-     * Returns metadata from a given resource
-     * @param name Name of a resource
-     * @returns Metadata from the resource.
-     */
-    resource<Type>(name: string): Type | undefined;
-    /**
-     * Returns resource cache.
+     * Removes an attachment from a card.
+     * @param cardKey The card to remove attachment from
+     * @param fileName The name of the attachment file to remove
+     * @throws if trying to remove module card attachment, or the attachment was not found.
      */
-    get resourceCache(): Map<string, JSON>;
+    removeCardAttachment(cardKey: string, fileName: string): Promise<void>;
     /**
-     * Checks if a given resource exists in the project already.
-     * @param resourceType Type of resource as a string.
-     * @param name Valid name of resource.
-     * @returns boolean, true if resource exists; false otherwise.
+     * Removes a module from the project cache and configuration.
+     * @note that ModuleManager removes the actual files.
+     * @param moduleName Module name to remove.
      */
-    resourceExists(resourceType: ResourceFolderType, name: string): Promise<boolean>;
+    removeModule(moduleName: string): Promise<void>;
     /**
-     * Instantiates resource object from project with a resource name.
-     * @note that this is memory based object only.
-     *       To manipulate the resource (create files, delete files etc), use the resource object's API.
-     * @param project Project from which resources are created from.
-     * @param name Resource name
-     * @throws if called with unsupported resource type.
-     * @returns Created resource.
+     * Accessor for resource handler.
+     * @returns Resource handler instance.
      */
-    static resourceObject(project: Project, name: ResourceName): CalculationResource | CardTypeResource | FieldTypeResource | GraphModelResource | GraphViewResource | LinkTypeResource | ReportResource | TemplateResource | WorkflowResource;
+    get resources(): ResourceHandler;
     /**
      * Shows details of a project.
      * @returns details of a project.
@@ -375,12 +273,6 @@ export declare class Project extends CardContainer {
      * @returns List of cards from template.
      */
     templateCards(templateName: string): Card[];
-    /**
-     * Array of templates in the project.
-     * @param from Defines where resources are collected from.
-     * @returns array of all templates in the project.
-     */
-    templates(from?: ResourcesFrom): Promise<Resource[]>;
     /**
      * Update a card's content.
      * @param cardKey card key to update.
@@ -406,11 +298,4 @@ export declare class Project extends CardContainer {
      * @param changedMetadata changed content for the card
      */
     updateCardMetadata(card: Card, changedMetadata: CardMetadata): Promise<void>;
-    private validateCard;
-    /**
-     * Array of workflows in the project.
-     * @param from Defines where resources are collected from.
-     * @returns array of all workflows in the project.
-     */
-    workflows(from?: ResourcesFrom): Promise<Resource[]>;
 }