@cyberismo/data-handler 0.0.2

package/dist/commands/update.js

@@ -0,0 +1,64 @@
+/**
+    Cyberismo
+    Copyright © Cyberismo Ltd and contributors 2024
+
+    This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 as published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public
+    License along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+import { Project } from '../containers/project.js';
+import { resourceName } from '../utils/resource-utils.js';
+/**
+ * Class that handles 'update' commands.
+ */
+export class Update {
+    project;
+    constructor(project) {
+        this.project = project;
+    }
+    /**
+     * Updates single resource property.
+     * @param name Name of the resource to operate on.
+     * @param operation Operation to perform ('add', 'remove', 'change', 'rank')
+     * @param key Property to change in resource JSON
+     * @param value Value for 'key'
+     * @param optionalDetail Additional detail needed for some operations. For example, 'update' needs a new value.
+     */
+    async updateValue(name, operation, key, value, optionalDetail) {
+        const resource = Project.resourceObject(this.project, resourceName(name));
+        const op = {
+            name: operation,
+            target: '',
+            to: '',
+            newIndex: 0,
+        };
+        // Set operation specific properties.
+        if (operation === 'add') {
+            op.target = value;
+        }
+        else if (operation === 'change') {
+            op.target = optionalDetail
+                ? value
+                : optionalDetail;
+            op.to = optionalDetail
+                ? optionalDetail
+                : value;
+        }
+        else if (operation === 'rank') {
+            op.newIndex = optionalDetail;
+            op.target = value;
+        }
+        else if (operation === 'remove') {
+            op.target = value;
+            op.replacementValue = optionalDetail
+                ? optionalDetail
+                : undefined;
+        }
+        await resource?.update(key, op);
+        this.project.collectLocalResources();
+    }
+}
+//# sourceMappingURL=update.js.map

package/dist/commands/update.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update.js","sourceRoot":"","sources":["../../src/commands/update.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAUF,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,MAAM;IACG;IAApB,YAAoB,OAAgB;QAAhB,YAAO,GAAP,OAAO,CAAS;IAAG,CAAC;IAExC;;;;;;;OAOG;IACI,KAAK,CAAC,WAAW,CACtB,IAAY,EACZ,SAA2B,EAC3B,GAAW,EACX,KAAW,EACX,cAAqB;QAErB,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1E,MAAM,EAAE,GAAoB;YAC1B,IAAI,EAAE,SAAS;YACf,MAAM,EAAE,EAAU;YAClB,EAAE,EAAE,EAAU;YACd,QAAQ,EAAE,CAAW;SACtB,CAAC;QAEF,qCAAqC;QACrC,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;YACvB,EAAyB,CAAC,MAAM,GAAG,KAAK,CAAC;QAC5C,CAAC;aAAM,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;YACjC,EAA4B,CAAC,MAAM,GAAG,cAAc;gBACnD,CAAC,CAAC,KAAK;gBACP,CAAC,CAAE,cAAuB,CAAC;YAC5B,EAA4B,CAAC,EAAE,GAAG,cAAc;gBAC/C,CAAC,CAAC,cAAc;gBAChB,CAAC,CAAE,KAAc,CAAC;QACtB,CAAC;aAAM,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;YAC/B,EAA0B,CAAC,QAAQ,GAAG,cAAwB,CAAC;YAC/D,EAA0B,CAAC,MAAM,GAAG,KAAK,CAAC;QAC7C,CAAC;aAAM,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;YACjC,EAA4B,CAAC,MAAM,GAAG,KAAK,CAAC;YAC5C,EAA4B,CAAC,gBAAgB,GAAG,cAAc;gBAC7D,CAAC,CAAC,cAAc;gBAChB,CAAC,CAAC,SAAS,CAAC;QAChB,CAAC;QAED,MAAM,QAAQ,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAChC,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC;IACvC,CAAC;CACF"}

package/dist/commands/validate.d.ts

@@ -0,0 +1,143 @@
+/**
+  Cyberismo
+  Copyright © Cyberismo Ltd and contributors 2024
+  This program is free software: you can redistribute it and/or modify it under
+  the terms of the GNU Affero General Public License version 3 as published by
+  the Free Software Foundation.
+  This program is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+  FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+  details. You should have received a copy of the GNU Affero General Public
+  License along with this program. If not, see <https://www.gnu.org/licenses/>.
+*/
+import { Validator as JSONValidator } from 'jsonschema';
+import { Validator as DirectoryValidator } from 'directory-schema-validator';
+import type { Card, ResourceTypes } from '../interfaces/project-interfaces.js';
+import { Project } from '../containers/project.js';
+export interface LengthProvider {
+    length: number;
+}
+/**
+ * Validates content.
+ */
+export declare class Validate {
+    private static instance;
+    validator: JSONValidator;
+    directoryValidator: DirectoryValidator;
+    private parentSchema;
+    private validatedCardTypes;
+    private validatedWorkflows;
+    private validatedFieldTypes;
+    static baseFolder: string;
+    static jsonFileExtension: string;
+    static parentSchemaFile: string;
+    static schemaConfigurationFile: string;
+    static projectConfigurationFile: string;
+    static cardMetadataFile: string;
+    static dotSchemaSchemaId: string;
+    static parameterSchemaFile: string;
+    constructor();
+    private length;
+    private addChildSchemas;
+    private checkResourceName;
+    private fullPath;
+    private getAndCacheResource;
+    private parseValidatorMessage;
+    private readAndValidateContentFiles;
+    private removeDuplicateEntries;
+    private validateFolder;
+    private validateSchemaFiles;
+    private validateArrayOfFields;
+    private validateListValues;
+    private validType;
+    /**
+     * Validates that new identifier of a resource is according to naming convention.
+     * @param identifier: resource identifier
+     * returns true if identifier is valid, and false otherwise.
+     */
+    static isValidIdentifierName(identifier: string): boolean;
+    /**
+     * Validates that 'name' can be used as a project name.
+     * @param name project name
+     * @returns true if name is valid, and false otherwise.
+     * @note that on Windows, if path + filename is longer than 256 characters, some file operations
+     *       are not possible. Thus, setting the maximum length of project name to 64 characters.
+     *       The 192 characters usually should be enough for the path.
+     */
+    static isValidProjectName(name: string): boolean;
+    /**
+     * Validates that 'name' can be used as label name.
+     * Labels are less restricted than other names, as they are never file names.
+     * @param name label name
+     * @returns true if name is valid, and false otherwise.
+     */
+    static isValidLabelName(name: string): boolean;
+    /**
+     * Validates that a given directory path (and its children) conform to a JSON schema.
+     * @note Validates also content in the directory tree, if .schema file is found.
+     * @param projectPath path to validate.
+     * @returns string containing all validation errors
+     */
+    validate(projectPath: string): Promise<string>;
+    /**
+     * Validates folder name.
+     * @todo: This should check that the path is resolvable and can be used as a folder name in various operating systems.
+     * @param path path to a folder
+     * @returns true, if the path is valid and can be used; false otherwise.
+     */
+    static validateFolder(path: string): boolean;
+    /**
+     * Validates that 'object' conforms to JSON schema 'schemaId'.
+     * @param content Object to validate.
+     * @param schemaId Schema ID to identify a JSON schema.
+     * @returns string containing all validation errors
+     */
+    validateJson(content: object, schemaId: string): string;
+    /**
+     * Validate that resource names and identifiers are valid.
+     * @param resourceType Type of resource
+     * @param name Name of resource
+     * @param prefixes currently used project prefixes
+     * @returns resource name as valid resource name; throws in error cases.
+     */
+    validResourceName(resourceType: ResourceTypes, name: string, prefixes: string[]): Promise<string>;
+    /**
+     * Validates that 'prefix' is valid project prefix.
+     * @param prefix project prefix
+     * @returns true, if prefix can be used as project prefix, false otherwise.
+     */
+    static validatePrefix(prefix: string): boolean;
+    /**
+     * Validate schema that matches schemaId from path.
+     * @param projectPath path to schema
+     * @param schemaId schema's id
+     * @returns string containing all validation errors
+     * @todo - unused; remove?
+     */
+    validateSchema(projectPath: string, schemaId: string): Promise<string>;
+    /**
+     * Validates that card's custom fields are according to schema and have correct data in them.
+     * @param project currently used Project
+     * @param card specific card
+     * @returns string containing all validation errors
+     */
+    validateCustomFields(project: Project, card: Card): Promise<string>;
+    /**
+     * Validates the labels of a card
+     * @param card card to validate. Card must have metadata.
+     */
+    validateCardLabels(card: Card): Promise<string>;
+    /**
+     * Checks if card's current workflow state matches workflow that card's card type is using.
+     * Template cards are expected to have empty workflow state.
+     * @param project Project object.
+     * @param card Card object to validate
+     * @returns string containing all validation errors
+     */
+    validateWorkflowState(project: Project, card: Card): Promise<string>;
+    /**
+     * Possibly creates (if no instance exists) and returns an instance of Validate command.
+     * @returns instance of Validate command.
+     */
+    static getInstance(): Validate;
+}