vobi_document 1.0.1 → 1.1.0

package/dist/types-CvKSS1Sy.d.ts

@@ -0,0 +1,38 @@
+import { ComponentConfig, Config } from '@puckeditor/core';
+import { ReactNode, ComponentType } from 'react';
+import { ZodObject, ZodRawShape } from 'zod';
+
+/**
+ * Um bloco registrável; mesma `key` de um default da lib o substitui inteiro.
+ * O componente precisa ser puro, SSR-safe e print-safe — regras em docs/blocks.md.
+ */
+type BlockEntry<Props extends Record<string, unknown> = Record<string, unknown>> = {
+    key: string;
+    label?: string;
+    category?: string;
+    /** Icon shown next to the block name in the palette. */
+    icon?: ReactNode;
+    /** Puck field schema. Field keys should match the component prop names. */
+    fields: ComponentConfig<any>['fields'];
+    /**
+     * Zod schema for the block props. When provided, the document schema validates
+     * this block's props by `type` (strips unknown keys). Omit it and props are
+     * only checked for an `id` (passthrough). The `id` is added automatically.
+     */
+    propsSchema?: ZodObject<ZodRawShape>;
+    /** Props for a freshly dropped block. */
+    defaultProps?: Partial<Props>;
+    /** Puck permissions for the block (e.g. `{ duplicate: false }`). */
+    permissions?: ComponentConfig<any>['permissions'];
+    /** Pure React component (props -> JSX). No editor hooks — runs under SSR too. */
+    component: ComponentType<Props>;
+};
+/**
+ * Ordered list of blocks. Later entries override earlier ones by `key`.
+ * Loosely typed (`any` props) so heterogeneous blocks live in one array — the
+ * precise props typing is enforced at the `defineBlock` call site.
+ */
+type Registry = BlockEntry<any>[];
+type DocumentConfig = Config;
+
+export type { BlockEntry as B, DocumentConfig as D, Registry as R };

package/dist/variables.cjs

@@ -0,0 +1,95 @@
+'use strict';
+
+var chunkAQ5FAAP6_cjs = require('./chunk-AQ5FAAP6.cjs');
+var chunkKUB3TYG2_cjs = require('./chunk-KUB3TYG2.cjs');
+var chunkZXWOZZXO_cjs = require('./chunk-ZXWOZZXO.cjs');
+var chunkIRFFN74K_cjs = require('./chunk-IRFFN74K.cjs');
+
+
+
+Object.defineProperty(exports, "VariableMenu", {
+  enumerable: true,
+  get: function () { return chunkAQ5FAAP6_cjs.VariableMenu; }
+});
+Object.defineProperty(exports, "variableCatalogSchema", {
+  enumerable: true,
+  get: function () { return chunkAQ5FAAP6_cjs.variableCatalogSchema; }
+});
+Object.defineProperty(exports, "variableDefSchema", {
+  enumerable: true,
+  get: function () { return chunkAQ5FAAP6_cjs.variableDefSchema; }
+});
+Object.defineProperty(exports, "variableTypeSchema", {
+  enumerable: true,
+  get: function () { return chunkAQ5FAAP6_cjs.variableTypeSchema; }
+});
+Object.defineProperty(exports, "CHIP_CLASS", {
+  enumerable: true,
+  get: function () { return chunkKUB3TYG2_cjs.CHIP_CLASS; }
+});
+Object.defineProperty(exports, "INVALID_CHIP_CLASS", {
+  enumerable: true,
+  get: function () { return chunkKUB3TYG2_cjs.INVALID_CHIP_CLASS; }
+});
+Object.defineProperty(exports, "NOT_INFORMED_LABEL", {
+  enumerable: true,
+  get: function () { return chunkKUB3TYG2_cjs.NOT_INFORMED_LABEL; }
+});
+Object.defineProperty(exports, "buildVariableChipHtml", {
+  enumerable: true,
+  get: function () { return chunkKUB3TYG2_cjs.buildVariableChipHtml; }
+});
+Object.defineProperty(exports, "collectVariableIssues", {
+  enumerable: true,
+  get: function () { return chunkKUB3TYG2_cjs.collectVariableIssues; }
+});
+Object.defineProperty(exports, "resolveVariableHtml", {
+  enumerable: true,
+  get: function () { return chunkKUB3TYG2_cjs.resolveVariableHtml; }
+});
+Object.defineProperty(exports, "formatResolvedValues", {
+  enumerable: true,
+  get: function () { return chunkZXWOZZXO_cjs.formatResolvedValues; }
+});
+Object.defineProperty(exports, "formatValue", {
+  enumerable: true,
+  get: function () { return chunkZXWOZZXO_cjs.formatValue; }
+});
+Object.defineProperty(exports, "resolveDocumentVariables", {
+  enumerable: true,
+  get: function () { return chunkZXWOZZXO_cjs.resolveDocumentVariables; }
+});
+Object.defineProperty(exports, "CatalogProvider", {
+  enumerable: true,
+  get: function () { return chunkIRFFN74K_cjs.CatalogProvider; }
+});
+Object.defineProperty(exports, "ResolvedProvider", {
+  enumerable: true,
+  get: function () { return chunkIRFFN74K_cjs.ResolvedProvider; }
+});
+Object.defineProperty(exports, "extractBindingKeys", {
+  enumerable: true,
+  get: function () { return chunkIRFFN74K_cjs.extractBindingKeys; }
+});
+Object.defineProperty(exports, "findInvalidBindings", {
+  enumerable: true,
+  get: function () { return chunkIRFFN74K_cjs.findInvalidBindings; }
+});
+Object.defineProperty(exports, "useCatalog", {
+  enumerable: true,
+  get: function () { return chunkIRFFN74K_cjs.useCatalog; }
+});
+Object.defineProperty(exports, "useResolvedVariables", {
+  enumerable: true,
+  get: function () { return chunkIRFFN74K_cjs.useResolvedVariables; }
+});
+Object.defineProperty(exports, "useTranslator", {
+  enumerable: true,
+  get: function () { return chunkIRFFN74K_cjs.useTranslator; }
+});
+Object.defineProperty(exports, "useUnresolvedDisplay", {
+  enumerable: true,
+  get: function () { return chunkIRFFN74K_cjs.useUnresolvedDisplay; }
+});
+//# sourceMappingURL=variables.cjs.map
+//# sourceMappingURL=variables.cjs.map

package/dist/variables.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"variables.cjs"}

package/dist/variables.d.cts

@@ -0,0 +1,74 @@
+import { z } from 'zod';
+import { a as VariableCatalog, V as VariableDef, d as VariableType, R as ResolvedVariables, c as VariableResolver, b as VariableContext, U as UnresolvedDisplay } from './types-BgIugNWW.cjs';
+import * as react from 'react';
+import { ReactNode } from 'react';
+export { C as CatalogProvider, T as Translator, u as useCatalog, a as useTranslator } from './catalogContext-DenbX-OW.cjs';
+
+type Schema<T> = z.ZodType<T, z.ZodTypeDef, unknown>;
+declare const variableTypeSchema: Schema<VariableType>;
+declare const variableDefSchema: Schema<VariableDef>;
+declare const variableCatalogSchema: Schema<VariableCatalog>;
+
+/** Format a raw resolved value by its catalog type, pt-BR. preview == PDF. */
+declare function formatValue(type: VariableType, raw: unknown): string;
+
+/** Walk any document structure and collect every distinct variable key. */
+declare function extractBindingKeys(node: unknown): string[];
+/** Variable keys present in the document but absent from the catalog (orphans). */
+declare function findInvalidBindings(node: unknown, catalog: VariableDef[]): string[];
+
+/**
+ * Formata valores crus por tipo do catálogo. Keys sem valor ficam FORA do mapa
+ * (`undefined` = "não resolvida" — ver docs/variables.md).
+ */
+declare function formatResolvedValues(defs: VariableDef[], raw: Record<string, unknown>): ResolvedVariables;
+/** Resolve os bindings de `node` em strings pt-BR formatadas (preview == PDF). */
+declare function resolveDocumentVariables(node: unknown, catalog: VariableDef[], resolver: VariableResolver, ctx: VariableContext): Promise<ResolvedVariables>;
+
+type Props = {
+    accept?: VariableType[];
+    model?: string;
+    onPick: (def: VariableDef) => void;
+};
+declare function VariableMenu({ accept, model, onPick }: Props): react.JSX.Element;
+
+declare const NOT_INFORMED_LABEL = "N\u00E3o informado";
+declare const CHIP_CLASS = "dg-var";
+declare const INVALID_CHIP_CLASS = "dg-var--invalid";
+/** Markup canônico do chip de variável — editores de host inserem por aqui. */
+declare const buildVariableChipHtml: (def: {
+    key: string;
+    label?: string;
+    fullLabel?: string;
+}) => string;
+type ResolveOptions = {
+    keepChip?: boolean;
+    catalog?: VariableDef[];
+    unresolved?: UnresolvedDisplay;
+};
+/** Classifica os chips do documento em `unknown` (fora do catálogo) e `unresolved` (sem valor). */
+declare const collectVariableIssues: (data: unknown, catalog?: VariableDef[], resolved?: ResolvedVariables) => {
+    unknown: string[];
+    unresolved: string[];
+    hasIssues: boolean;
+};
+/**
+ * Resolve os chips de variável de um HTML: valor, "Não informado" ou inválido (⚠).
+ * `keepChip: false` (render/PDF) mantém um span marcador (data-var-key/data-var-type, sem class).
+ * `unresolved: 'label'` (contexto de template) preserva o chip (texto + class) e não marca chip fora do
+ * catálogo como inválido — o template não está ligado a um documento, então "key desconhecida" ali é ruído.
+ * Ver docs/variables.md.
+ */
+declare const resolveVariableHtml: (html: string, resolved?: ResolvedVariables, { keepChip, catalog, unresolved }?: ResolveOptions) => string;
+
+type EnsureResolved = (keys: string[]) => Promise<void>;
+declare function ResolvedProvider({ resolved, ensureResolved, unresolvedDisplay, children }: {
+    resolved?: ResolvedVariables;
+    ensureResolved?: EnsureResolved;
+    unresolvedDisplay?: UnresolvedDisplay;
+    children: ReactNode;
+}): react.JSX.Element;
+declare function useResolvedVariables(): ResolvedVariables;
+declare function useUnresolvedDisplay(): UnresolvedDisplay;
+
+export { CHIP_CLASS, INVALID_CHIP_CLASS, NOT_INFORMED_LABEL, ResolvedProvider, ResolvedVariables, UnresolvedDisplay, VariableCatalog, VariableContext, VariableDef, VariableMenu, VariableResolver, VariableType, buildVariableChipHtml, collectVariableIssues, extractBindingKeys, findInvalidBindings, formatResolvedValues, formatValue, resolveDocumentVariables, resolveVariableHtml, useResolvedVariables, useUnresolvedDisplay, variableCatalogSchema, variableDefSchema, variableTypeSchema };

package/dist/variables.d.ts

@@ -0,0 +1,74 @@
+import { z } from 'zod';
+import { a as VariableCatalog, V as VariableDef, d as VariableType, R as ResolvedVariables, c as VariableResolver, b as VariableContext, U as UnresolvedDisplay } from './types-BgIugNWW.js';
+import * as react from 'react';
+import { ReactNode } from 'react';
+export { C as CatalogProvider, T as Translator, u as useCatalog, a as useTranslator } from './catalogContext-HGMU-w_4.js';
+
+type Schema<T> = z.ZodType<T, z.ZodTypeDef, unknown>;
+declare const variableTypeSchema: Schema<VariableType>;
+declare const variableDefSchema: Schema<VariableDef>;
+declare const variableCatalogSchema: Schema<VariableCatalog>;
+
+/** Format a raw resolved value by its catalog type, pt-BR. preview == PDF. */
+declare function formatValue(type: VariableType, raw: unknown): string;
+
+/** Walk any document structure and collect every distinct variable key. */
+declare function extractBindingKeys(node: unknown): string[];
+/** Variable keys present in the document but absent from the catalog (orphans). */
+declare function findInvalidBindings(node: unknown, catalog: VariableDef[]): string[];
+
+/**
+ * Formata valores crus por tipo do catálogo. Keys sem valor ficam FORA do mapa
+ * (`undefined` = "não resolvida" — ver docs/variables.md).
+ */
+declare function formatResolvedValues(defs: VariableDef[], raw: Record<string, unknown>): ResolvedVariables;
+/** Resolve os bindings de `node` em strings pt-BR formatadas (preview == PDF). */
+declare function resolveDocumentVariables(node: unknown, catalog: VariableDef[], resolver: VariableResolver, ctx: VariableContext): Promise<ResolvedVariables>;
+
+type Props = {
+    accept?: VariableType[];
+    model?: string;
+    onPick: (def: VariableDef) => void;
+};
+declare function VariableMenu({ accept, model, onPick }: Props): react.JSX.Element;
+
+declare const NOT_INFORMED_LABEL = "N\u00E3o informado";
+declare const CHIP_CLASS = "dg-var";
+declare const INVALID_CHIP_CLASS = "dg-var--invalid";
+/** Markup canônico do chip de variável — editores de host inserem por aqui. */
+declare const buildVariableChipHtml: (def: {
+    key: string;
+    label?: string;
+    fullLabel?: string;
+}) => string;
+type ResolveOptions = {
+    keepChip?: boolean;
+    catalog?: VariableDef[];
+    unresolved?: UnresolvedDisplay;
+};
+/** Classifica os chips do documento em `unknown` (fora do catálogo) e `unresolved` (sem valor). */
+declare const collectVariableIssues: (data: unknown, catalog?: VariableDef[], resolved?: ResolvedVariables) => {
+    unknown: string[];
+    unresolved: string[];
+    hasIssues: boolean;
+};
+/**
+ * Resolve os chips de variável de um HTML: valor, "Não informado" ou inválido (⚠).
+ * `keepChip: false` (render/PDF) mantém um span marcador (data-var-key/data-var-type, sem class).
+ * `unresolved: 'label'` (contexto de template) preserva o chip (texto + class) e não marca chip fora do
+ * catálogo como inválido — o template não está ligado a um documento, então "key desconhecida" ali é ruído.
+ * Ver docs/variables.md.
+ */
+declare const resolveVariableHtml: (html: string, resolved?: ResolvedVariables, { keepChip, catalog, unresolved }?: ResolveOptions) => string;
+
+type EnsureResolved = (keys: string[]) => Promise<void>;
+declare function ResolvedProvider({ resolved, ensureResolved, unresolvedDisplay, children }: {
+    resolved?: ResolvedVariables;
+    ensureResolved?: EnsureResolved;
+    unresolvedDisplay?: UnresolvedDisplay;
+    children: ReactNode;
+}): react.JSX.Element;
+declare function useResolvedVariables(): ResolvedVariables;
+declare function useUnresolvedDisplay(): UnresolvedDisplay;
+
+export { CHIP_CLASS, INVALID_CHIP_CLASS, NOT_INFORMED_LABEL, ResolvedProvider, ResolvedVariables, UnresolvedDisplay, VariableCatalog, VariableContext, VariableDef, VariableMenu, VariableResolver, VariableType, buildVariableChipHtml, collectVariableIssues, extractBindingKeys, findInvalidBindings, formatResolvedValues, formatValue, resolveDocumentVariables, resolveVariableHtml, useResolvedVariables, useUnresolvedDisplay, variableCatalogSchema, variableDefSchema, variableTypeSchema };

package/dist/variables.js

@@ -0,0 +1,6 @@
+export { VariableMenu, variableCatalogSchema, variableDefSchema, variableTypeSchema } from './chunk-ABIEQHS2.js';
+export { CHIP_CLASS, INVALID_CHIP_CLASS, NOT_INFORMED_LABEL, buildVariableChipHtml, collectVariableIssues, resolveVariableHtml } from './chunk-JEVWEGSE.js';
+export { formatResolvedValues, formatValue, resolveDocumentVariables } from './chunk-2EBYURIX.js';
+export { CatalogProvider, ResolvedProvider, extractBindingKeys, findInvalidBindings, useCatalog, useResolvedVariables, useTranslator, useUnresolvedDisplay } from './chunk-M2TPAU2F.js';
+//# sourceMappingURL=variables.js.map
+//# sourceMappingURL=variables.js.map

package/dist/variables.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"variables.js"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vobi_document",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
@@ -20,11 +20,37 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
+    "./blocks": {
+      "types": "./dist/blocks.d.ts",
+      "import": "./dist/blocks.js",
+      "require": "./dist/blocks.cjs"
+    },
+    "./editor": {
+      "types": "./dist/editor.d.ts",
+      "import": "./dist/editor.js",
+      "require": "./dist/editor.cjs"
+    },
+    "./render": {
+      "types": "./dist/render.d.ts",
+      "import": "./dist/render.js",
+      "require": "./dist/render.cjs"
+    },
+    "./print": {
+      "types": "./dist/print.d.ts",
+      "import": "./dist/print.js",
+      "require": "./dist/print.cjs"
+    },
+    "./variables": {
+      "types": "./dist/variables.d.ts",
+      "import": "./dist/variables.js",
+      "require": "./dist/variables.cjs"
+    },
     "./puck": {
       "types": "./dist/puck.d.ts",
       "import": "./dist/puck.js",
       "require": "./dist/puck.cjs"
-    }
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist"
@@ -34,19 +60,19 @@
     "node": ">=20"
   },
   "dependencies": {
-    "react-colorful": "^5.7.0",
-    "zod": "^3.24.1"
+    "react-colorful": "^5.7.0"
   },
   "peerDependencies": {
-    "@puckeditor/core": "^0.21.3",
+    "@puckeditor/core": "^0.23.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "styled-components": "^5.3.5"
+    "styled-components": "^5.3.5",
+    "zod": "^3.24.1"
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.2.0",
     "@eslint/js": "^9.18.0",
-    "@puckeditor/core": "^0.21.3",
+    "@puckeditor/core": "^0.23.0",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.1.0",
     "@types/jest": "^29.5.14",
@@ -75,19 +101,24 @@
     "ts-jest": "^29.2.5",
     "tsup": "^8.3.5",
     "typescript": "^5.7.3",
-    "yalc": "^1.0.0-pre.53"
+    "vite": "^6.0.7",
+    "@vitejs/plugin-react": "^4.3.4",
+    "yalc": "^1.0.0-pre.53",
+    "zod": "^3.24.1"
   },
   "scripts": {
     "embed:pagedjs": "node scripts/embed-pagedjs.mjs",
     "prebuild": "pnpm embed:pagedjs",
     "build": "tsup",
     "dev": "tsup --watch",
+    "play": "vite",
     "pretest": "pnpm embed:pagedjs",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
     "pretypecheck": "pnpm embed:pagedjs",
     "typecheck": "tsc --noEmit",
+    "typecheck:play": "tsc --noEmit -p tsconfig.playground.json",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "format": "prettier --write .",

package/dist/chunk-SY4NYXKN.js

@@ -1,3 +0,0 @@
-export { ActionBar, Puck, Render, registerOverlayPortal, useGetPuck, usePuck } from '@puckeditor/core';
-//# sourceMappingURL=chunk-SY4NYXKN.js.map
-//# sourceMappingURL=chunk-SY4NYXKN.js.map