@opensaas/stack-tiptap 0.39.2 → 0.40.0

package/.turbo/turbo-build.log

@@ -1,11 +1,11 @@
 
-> @opensaas/stack-tiptap@0.39.2 build /home/runner/work/stack/stack/packages/tiptap
+> @opensaas/stack-tiptap@0.40.0 build /home/runner/work/stack/stack/packages/tiptap
 > tsc && npm run copy:css
 
 npm warn Unknown env config "verify-deps-before-run". This will stop working in the next major version of npm. See `npm help npmrc` for supported config options.
 npm warn Unknown env config "npm-globalconfig". This will stop working in the next major version of npm. See `npm help npmrc` for supported config options.
 npm warn Unknown env config "_jsr-registry". This will stop working in the next major version of npm. See `npm help npmrc` for supported config options.
 
-> @opensaas/stack-tiptap@0.39.2 copy:css
+> @opensaas/stack-tiptap@0.40.0 copy:css
 > mkdir -p dist/styles && cp src/styles/tiptap.css dist/styles/
 

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @opensaas/stack-tiptap
 
+## 0.40.0
+
+### Patch Changes
+
+- [#973](https://github.com/OpenSaasAU/stack/pull/973) [`8f76533`](https://github.com/OpenSaasAU/stack/commit/8f765333e3067c741c69f535927cc82115c60ed1) Thanks [@borisno2](https://github.com/borisno2)! - Comment cleanup only, no behavior change: removed restating/narration comments, kept TSDoc on public config options and field builders, and kept external API/behavior constraint notes (Prisma, S3, Vercel Blob, Keystone parity, Next.js SSR, Zod).
+
 ## 0.39.2
 
 ## 0.39.1

package/dist/components/TiptapField.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TiptapField.d.ts","sourceRoot":"","sources":["../../src/components/TiptapField.tsx"],"names":[],"mappings":"AAEA,OAAO,EAA4B,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAI1E,OAAO,sBAAsB,CAAA;AAE7B,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAA;IAClC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAA;IACtC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,EAC1B,IAAI,EACJ,KAAK,EACL,QAAQ,EACR,KAAK,EACL,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,IAAa,EACb,WAAgC,EAChC,SAAe,EACf,SAAS,GACV,EAAE,gBAAgB,2CA0JlB"}
+{"version":3,"file":"TiptapField.d.ts","sourceRoot":"","sources":["../../src/components/TiptapField.tsx"],"names":[],"mappings":"AAEA,OAAO,EAA4B,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAI1E,OAAO,sBAAsB,CAAA;AAE7B,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAA;IAClC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAA;IACtC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,EAC1B,IAAI,EACJ,KAAK,EACL,QAAQ,EACR,KAAK,EACL,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,IAAa,EACb,WAAgC,EAChC,SAAe,EACf,SAAS,GACV,EAAE,gBAAgB,2CAqJlB"}

package/dist/components/TiptapField.js

@@ -37,13 +37,11 @@ export function TiptapField({ name, value, onChange, label, error, disabled, req
             },
         },
     });
-    // Update content when value changes externally
     useEffect(() => {
         if (editor && value !== editor.getJSON()) {
             editor.commands.setContent(value || '');
         }
     }, [editor, value]);
-    // Update editable state when mode or disabled changes
     useEffect(() => {
         if (editor) {
             editor.setEditable(isEditable);

package/dist/config/types.d.ts

@@ -9,25 +9,15 @@ export type RichTextField<TTypeInfo extends TypeInfo = TypeInfo> = BaseFieldConf
         isRequired?: boolean;
     };
     ui?: {
-        /**
-         * Placeholder text for empty editor
-         */
+        /** Placeholder text for empty editor */
         placeholder?: string;
-        /**
-         * Minimum height for editor in pixels
-         */
+        /** Minimum height for editor in pixels */
         minHeight?: number;
-        /**
-         * Maximum height for editor in pixels
-         */
+        /** Maximum height for editor in pixels */
         maxHeight?: number;
-        /**
-         * Custom React component to render this field
-         */
+        /** Custom React component to render this field */
         component?: any;
-        /**
-         * Custom field type name to use from the global registry
-         */
+        /** Custom field type name to use from the global registry */
         fieldType?: string;
     };
 };

package/dist/config/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AAE5E;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,SAAS,SAAS,QAAQ,GAAG,QAAQ,IAAI,eAAe,CAAC,SAAS,CAAC,GAAG;IAC9F,IAAI,EAAE,UAAU,CAAA;IAChB,UAAU,CAAC,EAAE;QACX,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAA;IACD,EAAE,CAAC,EAAE;QACH;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;WAEG;QAEH,SAAS,CAAC,EAAE,GAAG,CAAA;QACf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/config/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AAE5E;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,SAAS,SAAS,QAAQ,GAAG,QAAQ,IAAI,eAAe,CAAC,SAAS,CAAC,GAAG;IAC9F,IAAI,EAAE,UAAU,CAAA;IAChB,UAAU,CAAC,EAAE;QACX,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAA;IACD,EAAE,CAAC,EAAE;QACH,wCAAwC;QACxC,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,0CAA0C;QAC1C,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,0CAA0C;QAC1C,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,kDAAkD;QAElD,SAAS,CAAC,EAAE,GAAG,CAAA;QACf,6DAA6D;QAC7D,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;CACF,CAAA"}

package/dist/fields/richText.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"richText.d.ts","sourceRoot":"","sources":["../../src/fields/richText.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAEvD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,GAAG,aAAa,CAwC7E"}
+{"version":3,"file":"richText.d.ts","sourceRoot":"","sources":["../../src/fields/richText.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAEvD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,GAAG,aAAa,CAsC7E"}

package/dist/fields/richText.js

@@ -25,19 +25,17 @@ export function richText(options) {
         getZodSchema: (fieldName, operation) => {
             const validation = options?.validation;
             const isRequired = validation?.isRequired;
-            // Accept any valid JSON structure from Tiptap
-            // Tiptap outputs JSONContent which is a complex nested structure
+            // Tiptap emits a complex nested JSONContent structure; accept any valid JSON.
             const baseSchema = z.any();
             if (isRequired && operation === 'create') {
-                // For create, reject undefined
+                // Reject undefined on create.
                 return baseSchema;
             }
             else if (isRequired && operation === 'update') {
-                // For update, allow undefined (partial updates)
+                // Allow undefined on update (partial updates).
                 return z.union([baseSchema, z.undefined()]);
             }
             else {
-                // Not required
                 return baseSchema.optional();
             }
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensaas/stack-tiptap",
-  "version": "0.39.2",
+  "version": "0.40.0",
   "description": "Tiptap rich text editor integration for OpenSaas Stack",
   "type": "module",
   "main": "./dist/index.js",
@@ -56,8 +56,8 @@
     "react": "^19.2.8",
     "react-dom": "^19.2.8",
     "typescript": "npm:@typescript/typescript6@^6.0.2",
-    "@opensaas/stack-core": "0.39.2",
-    "@opensaas/stack-ui": "0.39.2"
+    "@opensaas/stack-core": "0.40.0",
+    "@opensaas/stack-ui": "0.40.0"
   },
   "scripts": {
     "build": "tsc && npm run copy:css",

package/src/components/TiptapField.tsx

@@ -66,14 +66,12 @@ export function TiptapField({
     },
   })
 
-  // Update content when value changes externally
   useEffect(() => {
     if (editor && value !== editor.getJSON()) {
       editor.commands.setContent(value || '')
     }
   }, [editor, value])
 
-  // Update editable state when mode or disabled changes
   useEffect(() => {
     if (editor) {
       editor.setEditable(isEditable)
@@ -98,9 +96,7 @@ export function TiptapField({
         {required && <span className="text-destructive">*</span>}
       </label>
 
-      {/* Editor with toolbar */}
       <div className={`tiptap-editor ${error ? 'border-destructive' : ''}`}>
-        {/* Toolbar */}
         {isEditable && editor && (
           <div className="tiptap-toolbar">
             <button
@@ -174,7 +170,6 @@ export function TiptapField({
           </div>
         )}
 
-        {/* Editor content */}
         <div
           className={disabled ? 'opacity-50 cursor-not-allowed' : ''}
           style={{

package/src/config/types.ts

@@ -10,26 +10,16 @@ export type RichTextField<TTypeInfo extends TypeInfo = TypeInfo> = BaseFieldConf
     isRequired?: boolean
   }
   ui?: {
-    /**
-     * Placeholder text for empty editor
-     */
+    /** Placeholder text for empty editor */
     placeholder?: string
-    /**
-     * Minimum height for editor in pixels
-     */
+    /** Minimum height for editor in pixels */
     minHeight?: number
-    /**
-     * Maximum height for editor in pixels
-     */
+    /** Maximum height for editor in pixels */
     maxHeight?: number
-    /**
-     * Custom React component to render this field
-     */
+    /** Custom React component to render this field */
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     component?: any
-    /**
-     * Custom field type name to use from the global registry
-     */
+    /** Custom field type name to use from the global registry */
     fieldType?: string
   }
 }

package/src/fields/richText.ts

@@ -28,18 +28,16 @@ export function richText(options?: Omit<RichTextField, 'type'>): RichTextField {
       const validation = options?.validation
       const isRequired = validation?.isRequired
 
-      // Accept any valid JSON structure from Tiptap
-      // Tiptap outputs JSONContent which is a complex nested structure
+      // Tiptap emits a complex nested JSONContent structure; accept any valid JSON.
       const baseSchema = z.any()
 
       if (isRequired && operation === 'create') {
-        // For create, reject undefined
+        // Reject undefined on create.
         return baseSchema
       } else if (isRequired && operation === 'update') {
-        // For update, allow undefined (partial updates)
+        // Allow undefined on update (partial updates).
         return z.union([baseSchema, z.undefined()])
       } else {
-        // Not required
         return baseSchema.optional()
       }
     },