@nutshelllabs/primitives - npm Package Compare versions

Comparing version 3.0.2 to 4.1.1

lib/index.d.ts

+declare const G = "G";
+declare const Svg = "SVG";
+declare const View = "VIEW";
+declare const Text = "TEXT";
+declare const Link = "LINK";
+declare const Page = "PAGE";
+declare const Note = "NOTE";
+declare const Path = "PATH";
+declare const Rect = "RECT";
+declare const Line = "LINE";
+declare const FieldSet = "FIELD_SET";
+declare const TextInput = "TEXT_INPUT";
+declare const Select = "SELECT";
+declare const Checkbox = "CHECKBOX";
+declare const List = "LIST";
+declare const Stop = "STOP";
+declare const Defs = "DEFS";
+declare const Image = "IMAGE";
+declare const Tspan = "TSPAN";
+declare const Canvas = "CANVAS";
+declare const Circle = "CIRCLE";
+declare const Ellipse = "ELLIPSE";
+declare const Polygon = "POLYGON";
+declare const Document = "DOCUMENT";
+declare const Polyline = "POLYLINE";
+declare const ClipPath = "CLIP_PATH";
+declare const TextInstance = "TEXT_INSTANCE";
+declare const LinearGradient = "LINEAR_GRADIENT";
+declare const RadialGradient = "RADIAL_GRADIENT";
+
+export { Canvas, Checkbox, Circle, ClipPath, Defs, Document, Ellipse, FieldSet, G, Image, Line, LinearGradient, Link, List, Note, Page, Path, Polygon, Polyline, RadialGradient, Rect, Select, Stop, Svg, Text, TextInput, TextInstance, Tspan, View };

lib/index.js

@@ -1,52 +0,31 @@
-"use strict";
-
-exports.__esModule = true;
-exports.View = exports.Tspan = exports.TextInstance = exports.Text = exports.Svg = exports.Stop = exports.Rect = exports.RadialGradient = exports.Polyline = exports.Polygon = exports.Path = exports.Page = exports.Note = exports.Link = exports.LinearGradient = exports.Line = exports.Image = exports.G = exports.Ellipse = exports.Document = exports.Defs = exports.ClipPath = exports.Circle = exports.Canvas = void 0;
 const G = 'G';
-exports.G = G;
 const Svg = 'SVG';
-exports.Svg = Svg;
 const View = 'VIEW';
-exports.View = View;
 const Text = 'TEXT';
-exports.Text = Text;
 const Link = 'LINK';
-exports.Link = Link;
 const Page = 'PAGE';
-exports.Page = Page;
 const Note = 'NOTE';
-exports.Note = Note;
 const Path = 'PATH';
-exports.Path = Path;
 const Rect = 'RECT';
-exports.Rect = Rect;
 const Line = 'LINE';
-exports.Line = Line;
+const FieldSet = 'FIELD_SET';
+const TextInput = 'TEXT_INPUT';
+const Select = 'SELECT';
+const Checkbox = 'CHECKBOX';
+const List = 'LIST';
 const Stop = 'STOP';
-exports.Stop = Stop;
 const Defs = 'DEFS';
-exports.Defs = Defs;
 const Image = 'IMAGE';
-exports.Image = Image;
 const Tspan = 'TSPAN';
-exports.Tspan = Tspan;
 const Canvas = 'CANVAS';
-exports.Canvas = Canvas;
 const Circle = 'CIRCLE';
-exports.Circle = Circle;
 const Ellipse = 'ELLIPSE';
-exports.Ellipse = Ellipse;
 const Polygon = 'POLYGON';
-exports.Polygon = Polygon;
 const Document = 'DOCUMENT';
-exports.Document = Document;
 const Polyline = 'POLYLINE';
-exports.Polyline = Polyline;
 const ClipPath = 'CLIP_PATH';
-exports.ClipPath = ClipPath;
 const TextInstance = 'TEXT_INSTANCE';
-exports.TextInstance = TextInstance;
 const LinearGradient = 'LINEAR_GRADIENT';
-exports.LinearGradient = LinearGradient;
 const RadialGradient = 'RADIAL_GRADIENT';
-exports.RadialGradient = RadialGradient;
+
+export { Canvas, Checkbox, Circle, ClipPath, Defs, Document, Ellipse, FieldSet, G, Image, Line, LinearGradient, Link, List, Note, Page, Path, Polygon, Polyline, RadialGradient, Rect, Select, Stop, Svg, Text, TextInput, TextInstance, Tspan, View };

package.json

 {
   "name": "@nutshelllabs/primitives",
-  "version": "3.0.2",
+  "version": "4.1.1",
   "license": "MIT",
   "description": "Define uninitialized elements",
-  "author": "Nutshell Labs <[e-mail]>",
-  "homepage": "https://github.com/nutshelllabs/react-pdf#readme",
+  "author": "Diego Muracciole <[e-mail]>",
+  "homepage": "https://github.com/diegomura/react-pdf#readme",
+  "type": "module",
   "main": "./lib/index.js",
-  "module": "./src/index.js",
+  "types": "./lib/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/nutshelllabs/react-pdf.git",
+    "url": "https://github.com/diegomura/react-pdf.git",
     "directory": "packages/primitives"
   },
   "scripts": {
-    "build": "babel src --out-dir lib",
-    "test": "jest"
+    "build": "rimraf ./lib && rollup -c",
+    "watch": "rimraf ./lib && rollup -c -w",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
   },
   "files": [
-    "lib",
-    "src"
+    "lib"
   ]
 }

README.md

@@ -6,1 +6,77 @@ <p align="center">
 # @nutshelllabs/primitives
+
+Internal element type constants for react-pdf. This package defines the primitive node types used throughout the react-pdf rendering pipeline.
+
+## Installation
+
+```bash
+yarn add @nutshelllabs/primitives
+```
+
+## Usage
+
+```js
+import { View, Text, Page, Document } from '@nutshelllabs/primitives';
+
+console.log(View); // 'VIEW'
+console.log(Text); // 'TEXT'
+console.log(Page); // 'PAGE'
+console.log(Document); // 'DOCUMENT'
+```
+
+These constants are primarily used internally by react-pdf packages to identify element types during the rendering process.
+
+## Available Primitives
+
+### Document Structure
+
+| Export     | Value        | Description                       |
+| ---------- | ------------ | --------------------------------- |
+| `Document` | `'DOCUMENT'` | Root document container           |
+| `Page`     | `'PAGE'`     | Individual page within a document |
+| `View`     | `'VIEW'`     | Generic container element         |
+| `Text`     | `'TEXT'`     | Text content container            |
+| `Link`     | `'LINK'`     | Hyperlink element                 |
+| `Note`     | `'NOTE'`     | Annotation/note element           |
+| `Image`    | `'IMAGE'`    | Image element                     |
+| `Canvas`   | `'CANVAS'`   | Custom drawing canvas             |
+
+### Form Elements
+
+| Export      | Value          | Description                   |
+| ----------- | -------------- | ----------------------------- |
+| `FieldSet`  | `'FIELD_SET'`  | Form field grouping container |
+| `TextInput` | `'TEXT_INPUT'` | Text input field              |
+| `Select`    | `'SELECT'`     | Dropdown select field         |
+| `Checkbox`  | `'CHECKBOX'`   | Checkbox input field          |
+| `List`      | `'LIST'`       | List element for forms        |
+
+### SVG Elements
+
+| Export           | Value               | Description                |
+| ---------------- | ------------------- | -------------------------- |
+| `Svg`            | `'SVG'`             | SVG root container         |
+| `G`              | `'G'`               | SVG group element          |
+| `Path`           | `'PATH'`            | SVG path element           |
+| `Rect`           | `'RECT'`            | SVG rectangle element      |
+| `Line`           | `'LINE'`            | SVG line element           |
+| `Circle`         | `'CIRCLE'`          | SVG circle element         |
+| `Ellipse`        | `'ELLIPSE'`         | SVG ellipse element        |
+| `Polygon`        | `'POLYGON'`         | SVG polygon element        |
+| `Polyline`       | `'POLYLINE'`        | SVG polyline element       |
+| `Tspan`          | `'TSPAN'`           | SVG text span element      |
+| `ClipPath`       | `'CLIP_PATH'`       | SVG clipping path          |
+| `Defs`           | `'DEFS'`            | SVG definitions container  |
+| `Stop`           | `'STOP'`            | Gradient stop element      |
+| `LinearGradient` | `'LINEAR_GRADIENT'` | Linear gradient definition |
+| `RadialGradient` | `'RADIAL_GRADIENT'` | Radial gradient definition |
+
+### Internal Types
+
+| Export         | Value             | Description                             |
+| -------------- | ----------------- | --------------------------------------- |
+| `TextInstance` | `'TEXT_INSTANCE'` | Internal representation of text content |
+
+## License
+
+MIT

src/index.js

-export const G = 'G';
-export const Svg = 'SVG';
-export const View = 'VIEW';
-export const Text = 'TEXT';
-export const Link = 'LINK';
-export const Page = 'PAGE';
-export const Note = 'NOTE';
-export const Path = 'PATH';
-export const Rect = 'RECT';
-export const Line = 'LINE';
-export const Stop = 'STOP';
-export const Defs = 'DEFS';
-export const Image = 'IMAGE';
-export const Tspan = 'TSPAN';
-export const Canvas = 'CANVAS';
-export const Circle = 'CIRCLE';
-export const Ellipse = 'ELLIPSE';
-export const Polygon = 'POLYGON';
-export const Document = 'DOCUMENT';
-export const Polyline = 'POLYLINE';
-export const ClipPath = 'CLIP_PATH';
-export const TextInstance = 'TEXT_INSTANCE';
-export const LinearGradient = 'LINEAR_GRADIENT';
-export const RadialGradient = 'RADIAL_GRADIENT';

No alert changes

Improved metrics

Total package byte prevSize

6314

98.24%

Number of lines in readme file

82

1266.67%

Is type module

Yes

NaN

Worsened metrics

Lines of code

60

-20%

No dependency changes