@inditextech/weave-types 0.1.0

package/README.md

@@ -0,0 +1,282 @@
+<!--
+SPDX-FileCopyrightText: 2025 2025 INDUSTRIA DE DISEÑO TEXTIL S.A. (INDITEX S.A.)
+
+SPDX-License-Identifier: Apache-2.0
+-->
+
+[![npm version](https://badge.fury.io/js/angular2-expandable-list.svg)](https://badge.fury.io/js/angular2-expandable-list)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+# Weave.js / SDK
+
+> Write a project description
+
+## Prerequisites
+
+This project requires NodeJS (version 8 or later) and NPM.
+[Node](http://nodejs.org/) and [NPM](https://npmjs.org/) are really easy to install.
+To make sure you have them available on your machine,
+try running the following command.
+
+```sh
+$ npm -v && node -v
+6.4.1
+v8.16.0
+```
+
+## Table of contents
+
+- [Project Name](#project-name)
+  - [Prerequisites](#prerequisites)
+  - [Table of contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Serving the app](#serving-the-app)
+    - [Running the tests](#running-the-tests)
+    - [Building a distribution version](#building-a-distribution-version)
+    - [Serving the distribution version](#serving-the-distribution-version)
+  - [API](#api)
+    - [useBasicFetch](#usebasicfetch)
+      - [Options](#options)
+    - [fetchData](#fetchdata)
+  - [Contributing](#contributing)
+  - [Credits](#credits)
+  - [Built With](#built-with)
+  - [Versioning](#versioning)
+  - [Authors](#authors)
+  - [License](#license)
+
+## Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+## Installation
+
+**BEFORE YOU INSTALL:** please read the [prerequisites](#prerequisites)
+
+Start with cloning this repo on your local machine:
+
+```sh
+$ git clone https://github.com/ORG/PROJECT.git
+$ cd PROJECT
+```
+
+To install and set up the library, run:
+
+```sh
+$ npm install -S myLib
+```
+
+Or if you prefer using Yarn:
+
+```sh
+$ yarn add --dev myLib
+```
+
+## Usage
+
+### Serving the app
+
+```sh
+$ npm start
+```
+
+### Running the tests
+
+```sh
+$ npm test
+```
+
+### Building a distribution version
+
+```sh
+$ npm run build
+```
+
+This task will create a distribution version of the project
+inside your local `dist/` folder
+
+### Serving the distribution version
+
+```sh
+$ npm run serve:dist
+```
+
+This will use `lite-server` for servign your already
+generated distribution version of the project.
+
+_Note_ this requires
+[Building a distribution version](#building-a-distribution-version) first.
+
+## API
+
+### useBasicFetch
+
+```js
+useBasicFetch(((url: string) = ''), ((delay: number) = 0));
+```
+
+Supported options and result fields for the `useBasicFetch` hook are listed below.
+
+#### Options
+
+`url`
+
+| Type   | Default value |
+| ------ | ------------- |
+| string | ''            |
+
+If present, the request will be performed as soon as the component is mounted
+
+Example:
+
+```tsx
+const MyComponent: React.FC = () => {
+  const { data, error, loading } = useBasicFetch(
+    'https://api.icndb.com/jokes/random'
+  );
+
+  if (error) {
+    return <p>Error</p>;
+  }
+
+  if (loading) {
+    return <p>Loading...</p>;
+  }
+
+  return (
+    <div className="App">
+      <h2>Chuck Norris Joke of the day</h2>
+      {data && data.value && <p>{data.value.joke}</p>}
+    </div>
+  );
+};
+```
+
+`delay`
+
+| Type   | Default value | Description          |
+| ------ | ------------- | -------------------- |
+| number | 0             | Time in milliseconds |
+
+If present, the request will be delayed by the given amount of time
+
+Example:
+
+```tsx
+type Joke = {
+  value: {
+    id: number;
+    joke: string;
+  };
+};
+
+const MyComponent: React.FC = () => {
+  const { data, error, loading } = useBasicFetch<Joke>(
+    'https://api.icndb.com/jokes/random',
+    2000
+  );
+
+  if (error) {
+    return <p>Error</p>;
+  }
+
+  if (loading) {
+    return <p>Loading...</p>;
+  }
+
+  return (
+    <div className="App">
+      <h2>Chuck Norris Joke of the day</h2>
+      {data && data.value && <p>{data.value.joke}</p>}
+    </div>
+  );
+};
+```
+
+### fetchData
+
+```js
+fetchData(url: string)
+```
+
+Perform an asynchronous http request against a given url
+
+```tsx
+type Joke = {
+  value: {
+    id: number;
+    joke: string;
+  };
+};
+
+const ChuckNorrisJokes: React.FC = () => {
+  const { data, fetchData, error, loading } = useBasicFetch<Joke>();
+  const [jokeId, setJokeId] = useState(1);
+
+  useEffect(() => {
+    fetchData(`https://api.icndb.com/jokes/${jokeId}`);
+  }, [jokeId, fetchData]);
+
+  const handleNext = () => setJokeId(jokeId + 1);
+
+  if (error) {
+    return <p>Error</p>;
+  }
+
+  const jokeData = data && data.value;
+
+  return (
+    <div className="Comments">
+      {loading && <p>Loading...</p>}
+      {!loading && jokeData && (
+        <div>
+          <p>Joke ID: {jokeData.id}</p>
+          <p>{jokeData.joke}</p>
+        </div>
+      )}
+      {!loading && jokeData && !jokeData.joke && <p>{jokeData}</p>}
+      <button disabled={loading} onClick={handleNext}>
+        Next Joke
+      </button>
+    </div>
+  );
+};
+```
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+1.  Fork it!
+2.  Create your feature branch: `git checkout -b my-new-feature`
+3.  Add your changes: `git add .`
+4.  Commit your changes: `git commit -am 'Add some feature'`
+5.  Push to the branch: `git push origin my-new-feature`
+6.  Submit a pull request :sunglasses:
+
+## Credits
+
+TODO: Write credits
+
+## Built With
+
+- Dropwizard - Bla bla bla
+- Maven - Maybe
+- Atom - ergaerga
+- Love
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
+
+## Authors
+
+- **John Doe** - _Initial work_ - [JohnDoe](https://github.com/JohnDoe)
+
+See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
+
+## License
+
+[MIT License](https://andreasonny.mit-license.org/2019) © Andrea SonnY

package/dist/types.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const E="mainLayer",A={IDLE:"idle",STARTING:"starting",LOADING_FONTS:"loadingFonts",RUNNING:"running"},_={UP:"up",DOWN:"down",FRONT:"front",BACK:"back"},T="white",O={PNG:"image/png",JPEG:"image/jpeg"},N={"image/png":".png","image/jpeg":".jpg"},e={CREATE:"create",UPDATE:"update",DELETE:"delete"};exports.STATE_ACTIONS=e;exports.WEAVE_EXPORT_BACKGROUND_COLOR=T;exports.WEAVE_EXPORT_FILE_FORMAT=N;exports.WEAVE_EXPORT_FORMATS=O;exports.WEAVE_INSTANCE_STATUS=A;exports.WEAVE_NODE_LAYER_ID=E;exports.WEAVE_NODE_POSITION=_;

package/dist/types.d.ts

@@ -0,0 +1,203 @@
+import { default as default_2 } from 'konva';
+
+export declare type GroupSerializable = default_2.NodeConfig & {
+    id: string;
+    type: 'group';
+    nodes: string[];
+};
+
+export declare type GroupsStateChange = {
+    action: StateAction;
+    value: GroupSerializable;
+};
+
+export declare type NodeSerializable = default_2.NodeConfig & {
+    id: string;
+    type: string;
+};
+
+export declare type NodesStateChange = {
+    action: StateAction;
+    value: NodeSerializable;
+};
+
+export declare const STATE_ACTIONS: {
+    readonly CREATE: "create";
+    readonly UPDATE: "update";
+    readonly DELETE: "delete";
+};
+
+export declare type StateAction = (typeof STATE_ACTIONS)[StateActionKeys];
+
+export declare type StateActionKeys = keyof typeof STATE_ACTIONS;
+
+export declare const WEAVE_EXPORT_BACKGROUND_COLOR = "white";
+
+export declare const WEAVE_EXPORT_FILE_FORMAT: {
+    readonly "image/png": ".png";
+    readonly "image/jpeg": ".jpg";
+};
+
+export declare const WEAVE_EXPORT_FORMATS: {
+    readonly PNG: "image/png";
+    readonly JPEG: "image/jpeg";
+};
+
+export declare const WEAVE_INSTANCE_STATUS: {
+    readonly IDLE: "idle";
+    readonly STARTING: "starting";
+    readonly LOADING_FONTS: "loadingFonts";
+    readonly RUNNING: "running";
+};
+
+export declare const WEAVE_NODE_LAYER_ID = "mainLayer";
+
+export declare const WEAVE_NODE_POSITION: {
+    readonly UP: "up";
+    readonly DOWN: "down";
+    readonly FRONT: "front";
+    readonly BACK: "back";
+};
+
+export declare interface WeaveActionBase {
+    init?(): void;
+    trigger(cancelAction: () => void, params?: unknown): unknown;
+    internalUpdate?(): void;
+    cleanup?(): void;
+}
+
+export declare type WeaveAwarenessChange<K extends string, T> = {
+    [key in K]: T;
+};
+
+export declare type WeaveCallbacks = {
+    onRender?: () => void;
+    onRoomLoaded?: (loaded: boolean) => void;
+    onInstanceStatus?: (status: WeaveStatus) => void;
+    onActiveActionChange?: (actionName: string | undefined) => void;
+    onStateChange?: (state: WeaveState) => void;
+    onUndoManagerStatusChange?: (undoManagerStatus: WeaveUndoRedoChange) => void;
+};
+
+export declare type WeaveConfig = {
+    store: WeaveStoreBase;
+    nodes?: WeaveNodeBase[];
+    actions?: WeaveActionBase[];
+    plugins?: WeavePluginBase[];
+    fonts?: WeaveFont[];
+    callbacks?: WeaveCallbacks;
+    logger?: WeaveLoggerConfig;
+};
+
+export declare type WeaveElementAttributes = {
+    [key: string]: any;
+    id?: string;
+    nodeType?: string;
+    children?: WeaveStateElement[];
+};
+
+export declare type WeaveElementInstance = default_2.Layer | default_2.Group | default_2.Shape;
+
+export declare type WeaveExportFileFormat = (typeof WEAVE_EXPORT_FILE_FORMAT)[WeaveExportFileFormatKeys];
+
+export declare type WeaveExportFileFormatKeys = keyof typeof WEAVE_EXPORT_FILE_FORMAT;
+
+export declare type WeaveExportFormat = (typeof WEAVE_EXPORT_FORMATS)[WeaveExportFormatKeys];
+
+export declare type WeaveExportFormatKeys = keyof typeof WEAVE_EXPORT_FORMATS;
+
+export declare type WeaveExportNodeOptions = {
+    format?: typeof WEAVE_EXPORT_FORMATS.PNG;
+    padding?: number;
+    pixelRatio?: number;
+    backgroundColor?: string;
+    quality?: number;
+};
+
+export declare type WeaveFont = {
+    id: string;
+    name: string;
+};
+
+export declare type WeaveLoggerConfig = {
+    disabled?: boolean;
+    level?: 'debug' | 'info' | 'warn' | 'error';
+};
+
+export declare interface WeaveNodeBase {
+    createNode(id: string, props: WeaveElementAttributes): WeaveStateElement;
+    createInstance(props: WeaveElementAttributes): WeaveElementInstance;
+    updateInstance(instance: WeaveElementInstance, nextProps: WeaveElementAttributes): void;
+    removeInstance(instance: WeaveElementInstance): void;
+    toNode(instance: WeaveElementInstance): WeaveStateElement;
+}
+
+export declare interface WeavePluginBase {
+    init?(): void;
+    render?(): void;
+    enable(): void;
+    disable(): void;
+    isEnabled(): boolean;
+}
+
+export declare type WeavePosition = (typeof WEAVE_NODE_POSITION)[WeavePositionKeys];
+
+export declare type WeavePositionKeys = keyof typeof WEAVE_NODE_POSITION;
+
+export declare type WeaveSelection = {
+    instance: default_2.Shape | default_2.Group;
+    node: WeaveStateElement;
+};
+
+export declare type WeaveState = {
+    weave: {
+        key: 'stage';
+        type: 'stage';
+        props: {
+            [key: string]: unknown;
+            id: 'stage';
+            children: WeaveStateElement[];
+        };
+    } | Record<string, WeaveStateElement>;
+};
+
+export declare type WeaveStateElement = {
+    key: string;
+    type: string;
+    props: WeaveElementAttributes;
+};
+
+export declare type WeaveStatus = (typeof WEAVE_INSTANCE_STATUS)[WeaveStatusKeys];
+
+export declare type WeaveStatusKeys = keyof typeof WEAVE_INSTANCE_STATUS;
+
+export declare interface WeaveStoreBase {
+    connect(): void;
+    disconnect(): void;
+    onAwarenessChange<K extends string, T>(callback: (changes: WeaveAwarenessChange<K, T>[]) => void): void;
+    setAwarenessInfo(field: string, value: unknown): void;
+}
+
+export declare type WeaveStoreOptions = {
+    getUser: () => WeaveUser;
+    undoManagerOptions?: WeaveUndoManagerOptions;
+};
+
+export declare type WeaveUndoManagerOptions = {
+    captureTimeout?: number;
+    trackedOrigins?: Set<any>;
+};
+
+export declare type WeaveUndoRedoChange = {
+    canRedo: boolean;
+    canUndo: boolean;
+    redoStackLength: number;
+    undoStackLength: number;
+};
+
+export declare type WeaveUser = {
+    name: string;
+    email: string;
+};
+
+export { }

package/dist/types.js

@@ -0,0 +1,30 @@
+const E = "mainLayer", n = {
+  IDLE: "idle",
+  STARTING: "starting",
+  LOADING_FONTS: "loadingFonts",
+  RUNNING: "running"
+}, A = {
+  UP: "up",
+  DOWN: "down",
+  FRONT: "front",
+  BACK: "back"
+}, T = "white", O = {
+  PNG: "image/png",
+  JPEG: "image/jpeg"
+}, _ = {
+  "image/png": ".png",
+  "image/jpeg": ".jpg"
+}, e = {
+  CREATE: "create",
+  UPDATE: "update",
+  DELETE: "delete"
+};
+export {
+  e as STATE_ACTIONS,
+  T as WEAVE_EXPORT_BACKGROUND_COLOR,
+  _ as WEAVE_EXPORT_FILE_FORMAT,
+  O as WEAVE_EXPORT_FORMATS,
+  n as WEAVE_INSTANCE_STATUS,
+  E as WEAVE_NODE_LAYER_ID,
+  A as WEAVE_NODE_POSITION
+};

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@inditextech/weave-types",
+  "version": "0.1.0",
+  "type": "module",
+  "license": "Apache-2.0",
+  "author": "Jesus Manuel Piñeiro Cid <jesusmpc@inditex.com>",
+  "homepage": "https://inditextech.github.io/weavejs",
+  "repository": "github:InditexTech/weavejs",
+  "maintainers": [
+    {
+      "name": "Jesus Manuel Piñeiro Cid",
+      "email": "jesusmpc@inditex.com"
+    }
+  ],
+  "exports": {
+    "import": "./dist/types.js",
+    "require": "./dist/types.cjs"
+  },
+  "types": "dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build:snapshot": "vite build --mode=development --sourcemap --emptyOutDir",
+    "build": "vite build --mode=production --minify --emptyOutDir",
+    "bump:snapshot": "npm version $npm_package_version.$(date \"+%s\")",
+    "bundle:analyze": "vite-bundle-visualizer",
+    "check": "echo \"Monorepo test script\" && exit 0",
+    "dev": "vite build --watch",
+    "dist:tag": "npm dist-tag add \"$(jq -r .name package.json)@$(jq -r .version package.json)\" \"$PR_TAG\" --registry=\"$NPM_PUBLISHING_REGISTRY\" --verbose",
+    "format": "npm run lint -- --quiet --fix --fix-type layout",
+    "link": "npm link",
+    "lint:fix": "npm run lint -- --fix",
+    "lint": "eslint ./src",
+    "publish:snapshot": "npm publish",
+    "release:perform": "npm publish --access public",
+    "release:prepare": "npm run verify",
+    "test": "vitest --typecheck --coverage --watch=false",
+    "dev:test": "vitest --typecheck",
+    "verify": "npm run lint && npm run test && npm run build",
+    "version:development": "npm version $(npm version minor)-SNAPSHOT",
+    "version:release": "npm version $RELEASE_VERSION -m \"[npm-scripts] prepare release $RELEASE_VERSION\" --tag-version-prefix \"\""
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "8.26.0",
+    "@typescript-eslint/parser": "8.26.0",
+    "@vitest/coverage-v8": "1.6.0",
+    "@vitest/ui": "1.6.0",
+    "eslint": "8.57.1",
+    "eslint-plugin-react": "7.34.1",
+    "eslint-plugin-react-hooks": "^4.6.2",
+    "typescript-eslint": "8.22.0",
+    "vite": "5.2.9",
+    "vite-bundle-visualizer": "1.1.0",
+    "vite-plugin-compression2": "1.0.0",
+    "vite-plugin-dts": "4.0.3",
+    "vitest": "1.6.0",
+    "vitest-sonar-reporter": "2.0.0"
+  },
+  "engines": {
+    "node": "^18.12 || ^20.11 || ^22.11",
+    "npm": ">= 8.19.x"
+  }
+}