@rsltda/components 1.0.11 → 1.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +32 -36
  2. package/custom-elements.json +2 -2
  3. package/package.json +6 -3
  4. package/rs-components.es.js +1 -0
package/README.md CHANGED
@@ -1,6 +1,12 @@
1
1
  # @rsltda/components
2
2
 
3
- Libreria de Web Components construida con Vite + TypeScript. El paquete expone principalmente el custom element `<rs-map>`, pensado para desplegar mapas de Google con puntos filtrables y panel lateral. El objetivo del `npm publish` es distribuir solo el bundle compilado (`dist/`) para poder reutilizar el componente via npm o CDN (jsDelivr) sin exponer el codigo fuente.
3
+ Web Components construidos con Vite + TypeScript. El paquete expone principalmente `<rs-map>`, componente orientado a mostrar en Google Maps las sucursales y distribuidores de Roland Spaarwater Ltda. en Chile, con puntos filtrables, panel lateral y cache local.
4
+
5
+ ## Alcance de uso
6
+
7
+ Este paquete se publica de forma abierta para fines de integracion tecnica, evaluacion y desarrollo. Sin embargo, el uso en produccion de marcas, nombres comerciales, endpoints, datos, logos, iconografia y otros activos asociados a Roland Spaarwater Ltda. debe realizarse unicamente con autorizacion expresa del titular correspondiente.
8
+
9
+ La publicacion de este paquete no concede por si misma derechos sobre marcas, identidad visual, contenidos ni datos comerciales de la empresa.
4
10
 
5
11
  ## Instalacion
6
12
 
@@ -8,20 +14,15 @@ Libreria de Web Components construida con Vite + TypeScript. El paquete expone p
8
14
  npm install @rsltda/components
9
15
  ```
10
16
 
11
- Al instalar, el paquete ya incluye los bundles `rs-components.es.js` (ESM) y `rs-components.iife.js`, mas las declaraciones TypeScript generadas en `dist/index.d.ts`.
12
-
13
- El paquete tambien publica `custom-elements.json`, lo que permite a herramientas compatibles ofrecer autocompletado y documentacion de atributos para `<rs-map>`.
14
-
15
17
  ## Uso rapido
16
18
 
17
- ### 1. Registrar el componente
19
+ ### Importar el componente
18
20
 
19
21
  ```ts
20
- import "@rsltda/components/dist/rs-components.es.js";
21
- // El bundle llama a safeDefine internamente, por lo que <rs-map> queda disponible en customElements.
22
+ import "@rsltda/components/rs-components.es.js";
22
23
  ```
23
24
 
24
- ### 2. Insertar en el DOM
25
+ ### Usarlo en HTML
25
26
 
26
27
  ```html
27
28
  <rs-map
@@ -29,45 +30,40 @@ import "@rsltda/components/dist/rs-components.es.js";
29
30
  tipo="1"
30
31
  height="600px"
31
32
  google-maps-key="TU_KEY"
32
- points-api-url="https://you.api.com/PuntosMapas"
33
33
  cache-days="30"
34
- marker-icon-base="https://you.cdn.com/marker/"
35
34
  ></rs-map>
36
35
  ```
37
36
 
38
- Todos los valores sensibles se inyectan mediante atributos, de modo que el bundle publicado se mantiene agnostico de tus credenciales.
39
-
40
- ### 3. Consumo via jsDelivr
37
+ ### Via jsDelivr
41
38
 
42
39
  ```html
43
- <script type="module" src="https://cdn.jsdelivr.net/npm/@rsltda/components/dist/rs-components.es.js"></script>
40
+ <script type="module" src="https://cdn.jsdelivr.net/npm/@rsltda/components/rs-components.es.js"></script>
44
41
  ```
45
42
 
46
- Tras cargar el script anterior, puedes usar `<rs-map>` en cualquier sitio estatico sin necesidad de build tooling.
47
-
48
- ## Publicacion en npm
43
+ ## Configuracion de `<rs-map>`
49
44
 
50
- Este repositorio solo publica la carpeta `dist/` gracias a la combinacion de `files` en `package.json` y `.npmignore`. Antes de `npm publish`, ejecuta `npm run prepublishOnly`, lo cual dispara `vite build` y luego `tsc -p tsconfig.build.json` para asegurar que los bundles y los `.d.ts` esten actualizados.
45
+ | Atributo | Descripcion |
46
+ | --- | --- |
47
+ | `marca` | Marca usada para filtrar puntos y resolver color/icono. |
48
+ | `tipo` | `0`/`1` o `sucursal`/`distribuidor`. |
49
+ | `height` | Altura CSS del componente. Por defecto `520px`. |
50
+ | `google-maps-key` | API key de Google Maps. |
51
+ | `points-api-url` | Endpoint base de puntos. El componente usa un valor por defecto interno cuando no se especifica uno. |
52
+ | `cache-days` | Dias de vigencia del cache local. Por defecto `30`. |
53
+ | `marker-icon-base` | URL base para iconos por marca. El componente usa un valor por defecto interno cuando no se especifica uno. |
54
+ | `marker-icon-default` | Icono de respaldo si no se quiere usar icono por marca. |
51
55
 
52
- ## Atributos principales de `<rs-map>`
56
+ ## Defaults importantes
53
57
 
54
- | Atributo | Descripcion |
55
- | ------------------ | ---------------------------------------------------------------------------- |
56
- | `marca` | String que determina filtros y colores (`ktm`, etc.). |
57
- | `tipo` | `0`/`1` o `sucursal`/`distribuidor`. |
58
- | `height` | Altura CSS del componente (`520px` por defecto). |
59
- | `google-maps-key` | API key de Google Maps utilizada para cargar el script JS. |
60
- | `points-api-url` | Endpoint que devuelve los puntos. Se le agregan query params `marca` y `tipo`. Por defecto usa `https://ap2.rs-shop.cl/web/PuntosMapas`. |
61
- | `cache-days` | Dias que el componente considera vigente el cache local; por defecto `30`. |
62
- | `marker-icon-base` | URL base para los iconos de los marcadores; se concatena con `<marca>.png`. Por defecto usa `https://cdn.rsltda.cl/logos/marker/`. |
63
- | `marker-icon-default` | Icono a usar cuando no se definio `marker-icon-base`; si tampoco se provee, se usara el marcador estandar de Google. |
58
+ - `points-api-url`: valor interno por defecto
59
+ - `marker-icon-base`: valor interno por defecto
60
+ - `cache-days`: `30`
64
61
 
65
- El componente es auto contenido: inyecta su propio Shadow DOM, maneja estados `loading/ready/error`, agrupa puntos por zona y sincroniza la lista lateral con el mapa.
62
+ ## Tipos y tooling
66
63
 
67
- ## Estructura relevante
64
+ El paquete incluye:
68
65
 
69
- - `src/components/rs-map.ts`: componente completo con la logica de Google Maps, fetch y UI.
70
- - `src/utils/define.ts`: helper `safeDefine` para evitar redefinir custom elements.
71
- - `src/index.ts`: entry principal que registra `RsMap` y reexporta la clase.
66
+ - `dist/index.d.ts`
67
+ - `custom-elements.json`
72
68
 
73
- Durante el build, Vite empaqueta `src/index.ts` siguiendo la configuracion de `vite.config.ts`, mientras que `tsconfig.build.json` genera las declaraciones de tipos en el mismo `dist/`. De esta forma, el paquete final listo para npm contiene unicamente artefactos compilados e ideales para distribuir de forma segura.
69
+ Eso ayuda con autocompletado en tooling compatible y tipado de `<rs-map>`.
package/custom-elements.json CHANGED
@@ -32,7 +32,7 @@
32
32
  },
33
33
  {
34
34
  "name": "points-api-url",
35
- "description": "Endpoint base de puntos. Por defecto usa https://ap2.rs-shop.cl/web/PuntosMapas."
35
+ "description": "Endpoint base de puntos. El componente usa un valor interno por defecto cuando no se especifica uno."
36
36
  },
37
37
  {
38
38
  "name": "cache-days",
@@ -40,7 +40,7 @@
40
40
  },
41
41
  {
42
42
  "name": "marker-icon-base",
43
- "description": "URL base para iconos por marca. Por defecto usa https://cdn.rsltda.cl/logos/marker/ y concatena <marca>.png."
43
+ "description": "URL base para iconos por marca. El componente usa un valor interno por defecto y concatena <marca>.png."
44
44
  },
45
45
  {
46
46
  "name": "marker-icon-default",
package/package.json CHANGED
@@ -1,14 +1,15 @@
1
1
  {
2
2
  "name": "@rsltda/components",
3
- "version": "1.0.11",
3
+ "version": "1.0.12",
4
4
  "description": "Libreria de Web Components (incluye <rs-map>)",
5
5
  "type": "module",
6
6
  "files": [
7
7
  "dist",
8
+ "rs-components.es.js",
8
9
  "custom-elements.json"
9
10
  ],
10
11
  "main": "dist/rs-components.iife.js",
11
- "module": "dist/rs-components.es.js",
12
+ "module": "rs-components.es.js",
12
13
  "types": "dist/index.d.ts",
13
14
  "customElements": "custom-elements.json",
14
15
  "scripts": {
@@ -16,8 +17,10 @@
16
17
  "build": "vite build",
17
18
  "build:types": "tsc -p tsconfig.build.json",
18
19
  "preview": "vite preview",
20
+ "readme:github": "node ./scripts/sync-readme.mjs github",
21
+ "readme:npm": "node ./scripts/sync-readme.mjs npm",
19
22
  "prepublishOnly": "npm run build && npm run build:types",
20
- "publicar": "npm run prepublishOnly && npm version patch --no-git-tag-version && npm publish --access public --ignore-scripts"
23
+ "publicar": "node ./scripts/publicar.mjs"
21
24
  },
22
25
  "keywords": [
23
26
  "web-components",
package/rs-components.es.js ADDED
@@ -0,0 +1 @@
1
+ export * from './dist/rs-components.es.js';