@digo-org/digo-api 1.0.2 → 1.0.3

package/README.md

@@ -1,3 +1,106 @@
-## Digo Api
+# Digo API
 
-Lorem ipsum.
+This package provides the API interfaces for DIGO Assets, making them available to other workspaces in the monorepo or external projects via npm.
+
+
+## Overview
+
+The Digo API package contains interfaces and utility functions that define and facilitate communication with Digo Assets. These components form the foundation for building applications that work with the Digo ecosystem.
+
+## Installation
+
+```bash
+npm install @digo-org/digo-api
+```
+
+## Usage
+
+```typescript
+import { DigoApi } from '@digo-org/digo-api';
+// or specific components
+import { YourSpecificComponent } from '@digo-org/digo-api';
+```
+
+## Updating the Package
+
+When you need to update the Digo API package, follow these steps:
+
+1. **Make Your Changes**:
+   - Update existing files or add new files in the `src/` directory
+   - Ensure you export any new types, interfaces, or functions from index.ts
+
+2. **Update Version**:
+   - Increment the version number in package.json following [Semantic Versioning](https://semver.org/):
+     - MAJOR version for incompatible API changes
+     - MINOR version for backward-compatible functionality
+     - PATCH version for backward-compatible bug fixes
+
+3. **Build & Test**:
+   ```bash
+   # Lint your code
+   npm run lint
+   
+   # Fix linting issues automatically
+   npm run lint:fix
+   
+   # Build the package
+   npm run build
+   ```
+
+4. **Commit Changes**:
+   - Commit all changes to your repository
+   - Use descriptive commit messages that explain your changes
+
+5. **Publish**:
+   ```bash
+   # The prepublish script will automatically run build
+   npm publish
+   ```
+
+## Understanding package.json
+
+The package.json file contains important configurations:
+
+```json
+{
+  "name": "@digo-org/digo-api",  // Package name with org scope
+  "private": false,              // Allows publishing to npm
+  "version": "1.0.2",            // Current package version
+  "type": "module",              // Use ES modules
+  "main": "src/index.ts",        // Main entry point
+  "types": "src/index.ts",       // TypeScript types entry point
+  "publishConfig": {             // Publishing configuration
+    "access": "public"           // Makes the scoped package publicly available
+  },
+  "scripts": {                   // NPM scripts
+    "build": "tsc --build",      // Compile TypeScript
+    "lint": "eslint ./src",      // Check code quality
+    "lint:fix": "eslint ./src --fix", // Fix code quality issues
+    "prepublish": "rm -rf ./dist && npm run build" // Pre-publish hook
+  },
+  "devDependencies": {           // Development dependencies
+    "@digo/dev-dependencies": "*" // Shared dev dependencies
+  }
+}
+```
+
+## Publishing
+
+Publishing is handled through npm:
+
+```bash
+# Login to npm if not already logged in
+npm login
+
+# Publish package
+npm publish
+```
+
+The `prepublish` script will automatically:
+1. Remove the old `dist` directory
+2. Run the build process to create a new `dist` directory with the latest code
+
+#### Publishing Issues
+- Verify you're logged into npm with the correct account
+- Ensure the version has been incremented
+- Check that you have the necessary permissions in the @digo-org organization

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@digo-org/digo-api",
   "private": false,
-  "version": "1.0.2",
+  "version": "1.0.3",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/digo-asset.ts

@@ -1,5 +1,10 @@
-import { ReactNode } from 'react';
+import { ReactNode }            from 'react';
+import { SingleParameterValue } from 'src/types';
 
 export abstract class DigoAsset {
+  public static onParameterChange(_parameterId: string, _entityId: string, _value: SingleParameterValue, _isGlobal: boolean) {
+    // Nothing to do here
+  }
+
   abstract render(): ReactNode;
 }

package/src/index.ts

@@ -1,7 +1,5 @@
-export interface DigoApi {
-  property: string;
-}
+export const KAKA = 'Viene de la api de digo';
 
 export * from '@digo-org/digo-api/src/digo-asset';
 
-export const KAKA = 'Viene de la api de digo';
+export * from '@digo-org/digo-api/src/types';

package/src/types.ts

@@ -0,0 +1,90 @@
+export interface VizAsset {
+  id:           string;
+  name:         string;
+  description:  string;
+  tags:         string[];
+  definition:   VizAssetDefinition;
+  template_id:  string;
+  last_updated: string;
+}
+
+export interface VizAssetDefinition {
+  globalParameters: ParametersValue;
+  instances:        Instance[];
+}
+
+export interface Instance {
+  id:                    string;
+  [parameterId: string]: SingleParameterValue;
+}
+
+export interface ParametersValue {
+  [parameterId: string]: SingleParameterValue;
+}
+
+export interface VizParameterProperties {
+  id:         string;
+  group:      string;
+  isGlobal:   boolean;
+  properties: ParameterProperties;
+}
+
+export enum ParameterType {
+  NUMBER,
+  BOOLEAN,
+  COLOR,
+  TEXT,
+  GRADIENT,
+}
+
+export type ParameterValue = SingleParameterValue | ArrayParameterValue;
+
+export type SingleParameterValue = number |  boolean | string | GradientStop[];
+
+export type ArrayParameterValue = number[] |  boolean[] | string[] | GradientStop[][];
+
+export interface ParameterProperties {
+  name?:        string;
+  type:         ParameterType;
+  definition:   ParameterNumberProperties | ParameterBooleanProperties | ParameterColorProperties | ParameterTextProperties | ParameterGradientProperties;
+  isArray?:     boolean;
+  arrayValues?: ArrayParameterValue;
+}
+
+export interface ParameterNumberProperties {
+  defaultValue: number;
+  min?:         number;
+  max?:         number;
+  icon:         string;
+  decimals?:    number;
+  step?:        number;
+  units?:       string;
+};
+
+export interface ParameterGradientProperties {
+  defaultValue: GradientStop[];
+};
+
+export interface ParameterTextProperties {
+  defaultValue: string;
+  placeholder?: string;
+};
+
+export interface ParameterColorProperties {
+  defaultValue: string;
+};
+
+export interface ParameterBooleanProperties {
+  defaultValue: boolean;
+};
+
+export interface ParameterArrayProperties {
+  defaultValue: ArrayParameterValue;
+  definition:   ParameterNumberProperties | ParameterBooleanProperties | ParameterColorProperties | ParameterTextProperties | ParameterGradientProperties;
+  labels:       string[];
+};
+
+export interface GradientStop {
+  color:   string; // hex
+  percent: number;
+}