@devgateway/dvz-wp-commons 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,194 @@
+# @devgateway/dvz-wp-commons
+
+Common utilities for Data Visualization in WordPress that can also be used in other projects.
+
+[![npm version](https://img.shields.io/npm/v/@devgateway/dvz-wp-commons.svg)](https://www.npmjs.com/package/@devgateway/dvz-wp-commons)
+[![MIT License](https://img.shields.io/npm/l/@devgateway/dvz-wp-commons.svg)](https://github.com/devgateway/data-viz-wordpress/blob/main/packages/commons/LICENSE)
+
+## Installation
+
+```bash
+npm install @devgateway/dvz-wp-commons
+# or
+yarn add @devgateway/dvz-wp-commons
+# or
+pnpm add @devgateway/dvz-wp-commons
+```
+
+## Overview
+
+This package provides a collection of reusable components, utilities, and type definitions for data-viz WordPress. It facilitates consistent handling of chart configurations, data formatting, API connections, and more.
+
+This package is used internally by DevGateway projects and is designed to be compatible with the project customizer, allowing for easy integration and extension in custom implementations.
+
+## Components
+
+### API and Data Configuration
+
+- **APIConfig**: Configuration component for API connections.
+- **CSVConfig**: Configuration for CSV data sources.
+- **MapCSVSourceConfig**: Configuration for CSV data sources specific to maps.
+- **DataFilters**: Components for filtering data in visualizations.
+
+### Chart Components
+
+- **ChartColors**: Provides color schemes (categorical, sequential, diverging) for charts.
+- **ChartLegends**: Customizable legend components for charts.
+- **ChartMeasures**: Components for configuring chart measures.
+- **Measures**: Utilities for handling data measures.
+- **Tooltip**: Customizable tooltip component for charts.
+
+### Block Components
+
+- **BlockEditWithAPIMetadata**: Block editor component with API metadata support.
+- **BlockEditWithFilters**: Block editor component with filter capabilities.
+- **ComponentWithSettings**: Component wrapper with settings panel.
+- **SizeConfig**: Configuration component for size settings.
+
+### Formatting Components
+
+- **Format**: Advanced formatting utilities for chart data.
+
+### Post Type Components
+
+- **Post**: Components and utilities for handling WordPress post data.
+
+## Utilities
+
+### API Utilities
+
+- **APIutils**: Utility functions for API operations.
+  - `getTranslatedOptions`
+  - `getTranslation`
+  - `isSupersetAPI`
+
+### Mobile Utilities
+
+- **MobileConfigUtils**: Utilities for mobile configurations.
+  - `extractAxisValues`
+  - `getSelectedLabelsForApp`
+  - `transformDataToAppObject`
+  - `updateMeasureLabels`
+  - `getSelectedItemsForApp`
+  - `getStoredOrSetItem`
+
+### UI Utilities
+
+- **Util**: General UI utilities.
+  - `panelFocus`
+  - `togglePanel`
+
+### Constants
+
+- **BLOCKS_CATEGORY**: Category definition for blocks.
+- **BLOCKS_NS**: Namespace for blocks.
+- **DEFAULT_FORMAT_SETTINGS**: Default settings for formatting.
+
+## Icons
+
+- **GenericIcon**: Generic icon component.
+- **ChartIcon**: Chart-specific icon component.
+
+## Types
+
+### Core Types
+
+- **Options**: Basic option type with label, value, and optional labels.
+- **Dimension**: Interface for data dimensions.
+- **Category/CategoryItem**: Types for data categorization.
+- **Measure**: Interface for data measures.
+- **Filter**: Interface for data filters.
+- **FileContent**: Interface for file content metadata.
+
+### Chart Types
+
+- **ChartColorsProps**: Props for chart colors component.
+- **ChartLegendsProps**: Props for chart legends component.
+- **ChartMeasuresProps**: Props for chart measures component.
+- **FormatProps**: Props for format component.
+- **MeasuresProps**: Props for measures component.
+- **DataFiltersProps**: Props for data filters component.
+- **MapCSVSourceConfigProps**: Props for map CSV source config component.
+
+### Block Types
+
+- **BlockEditWithAPIMetadataProps/State**: Props and state for BlockEditWithAPIMetadata.
+- **BlockEditWithFiltersProps/State**: Props and state for BlockEditWithFilters.
+- **ComponentWithSettingsProps/State**: Props and state for ComponentWithSettings.
+- **SizeConfigProps**: Props for SizeConfig component.
+
+### Data Types
+
+- **DgSettings**: Interface for global settings.
+- **EurekaResponse**: Interface for Eureka service responses.
+- **Menu**: Interface for menu structure.
+- **Media**: Interface for media attachments.
+- **SearchResult/SearchResults**: Types for search functionality.
+- **Taxonomy/Taxonomies**: Types for WordPress taxonomies.
+- **Wp_Types**: Types for WordPress content types.
+
+### Post Types
+
+- **Post**: Interface for WordPress posts.
+- **PostContent**: Interface for post content.
+- **PostLinks**: Interface for post links.
+- **PostYoastHeadJSON**: Interface for Yoast SEO data.
+- **PotentialActionType**: Enum for schema action types.
+- **PostSchema**: Interface for structured data schema.
+
+## Integration with Project Customizer
+
+This package is designed to be integrated with the project customizer, allowing for:
+
+- Custom component configurations
+- Theme-specific styling overrides
+- Extension of data types for project-specific needs
+- Custom visualization implementations
+
+When used with the project customizer, components from this package can be easily configured and extended to meet specific project requirements.
+
+## Usage Examples
+
+### Basic Chart Configuration
+
+```jsx
+import { ChartColors, ChartLegends, Format } from '@devgateway/dvz-wp-commons';
+
+const MyChartComponent = ({ attributes, setAttributes }) => {
+  return (
+    <div>
+      <ChartColors
+        attributes={attributes}
+        setAttributes={setAttributes}
+      />
+      <ChartLegends
+        attributes={attributes}
+        setAttributes={setAttributes}
+      />
+      <Format
+        attributes={attributes}
+        setAttributes={setAttributes}
+      />
+    </div>
+  );
+};
+```
+
+### API Configuration
+
+```jsx
+import { APIConfig } from '@devgateway/dvz-wp-commons';
+
+const MyAPIComponent = ({ attributes, setAttributes }) => {
+  return (
+    <APIConfig
+      attributes={attributes}
+      setAttributes={setAttributes}
+    />
+  );
+};
+```
+
+## License
+
+MIT

package/build/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/apiconfig.tsx","../src/apiutils.ts","../src/blocks.tsx","../src/csvsourceconfig.tsx","../src/chartcolors.tsx","../src/chartlegends.tsx","../src/chartmeasures.tsx","../src/constants.ts","../src/datafilters.tsx","../src/format.tsx","../src/mapcsvsourceconfig.tsx","../src/measures.tsx","../src/mobileconfigutils.ts","../src/tooltip.tsx","../src/util.tsx","../src/common-types.d.ts","../src/index.ts","../src/post-type.ts","../src/types.ts","../src/hooks/index.ts","../src/icons/chart.tsx","../src/icons/generic.tsx","../src/icons/index.ts"],"version":"5.8.3"}
+{"root":["../src/APIConfig.tsx","../src/APIutils.ts","../src/Blocks.tsx","../src/CSVSourceConfig.tsx","../src/ChartColors.tsx","../src/ChartLegends.tsx","../src/ChartMeasures.tsx","../src/Constants.ts","../src/DataFilters.tsx","../src/Format.tsx","../src/MapCSVSourceConfig.tsx","../src/Measures.tsx","../src/MobileConfigUtils.ts","../src/Tooltip.tsx","../src/Util.tsx","../src/common-types.d.ts","../src/index.ts","../src/post-type.ts","../src/types.ts","../src/hooks/index.ts","../src/icons/Chart.tsx","../src/icons/Generic.tsx","../src/icons/index.ts"],"version":"5.8.3"}

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@devgateway/dvz-wp-commons",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "private": false,
   "description": "Common Utilities for Data Viz Wordpress that can be also used in other projects",
   "author": "Sebastian Dimunzio",
+  "license": "MIT",
   "maintainers": [
     "Sebastian Dimunzio",
     "Timothy Mugo"
@@ -33,8 +34,8 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@anolilab/semantic-release-pnpm": "^1.1.10",
     "@babel/runtime": "^7.27.0",
+    "@colbyfayock/semantic-release-pnpm": "^1.2.2",
     "@semantic-release/changelog": "^6.0.3",
     "@types/lodash.isempty": "^4.4.9",
     "@types/papaparse": "^5.3.15",
@@ -69,6 +70,6 @@
     "format:js": "wp-scripts format-js",
     "lint:js": "wp-scripts lint-js",
     "start": "tsc -w",
-    "release": "semantic-release"
+    "ci:publish": "pnpm publish"
   }
 }

package/build/hooks/useSetting.d.ts

@@ -1,2 +0,0 @@
-export declare const useSetting: (setting: string) => any;
-export declare const useSettingWithFallback: (setting: string, fallback: any) => any;

package/build/hooks/useSetting.js

@@ -1,11 +0,0 @@
-import { useSelect } from "@wordpress/data";
-export const useSetting = (setting) => {
-    return useSelect((select) => {
-        // @ts-ignore
-        const settings = select('core/editor').getSettings();
-        return settings[setting];
-    }, []);
-};
-export const useSettingWithFallback = (setting, fallback) => {
-    return useSetting(setting) ?? fallback;
-};