fabric 5.3.0 → 6.0.0-beta1

package/src/util/transform_matrix_removal.ts

@@ -0,0 +1,60 @@
+import { Image } from '../shapes/Image';
+import type { FabricObject } from '../shapes/Object/FabricObject';
+import { TMat2D } from '../typedefs';
+import { qrDecompose } from './misc/matrix';
+
+type FabricObjectWithTransformMatrix = FabricObject & {
+  transformMatrix?: TMat2D;
+};
+
+/**
+ * This function is an helper for svg import. it decompose the transformMatrix
+ * and assign properties to object.
+ * untransformed coordinates
+ * @private
+ */
+const _assignTransformMatrixProps = (
+  object: FabricObjectWithTransformMatrix
+) => {
+  if (object.transformMatrix) {
+    const { scaleX, scaleY, angle, skewX } = qrDecompose(
+      object.transformMatrix
+    );
+    object.flipX = false;
+    object.flipY = false;
+    object.set('scaleX', scaleX);
+    object.set('scaleY', scaleY);
+    object.angle = angle;
+    object.skewX = skewX;
+    object.skewY = 0;
+  }
+};
+
+/**
+ * This function is an helper for svg import. it removes the transform matrix
+ * and set to object properties that fabricjs can handle
+ * @private
+ * @param {Object} preserveAspectRatioOptions
+ */
+export const removeTransformMatrixForSvgParsing = (
+  object: FabricObjectWithTransformMatrix,
+  preserveAspectRatioOptions?: any
+) => {
+  let center = object._findCenterFromElement();
+  if (object.transformMatrix) {
+    _assignTransformMatrixProps(object);
+    center = center.transform(object.transformMatrix);
+  }
+  delete object.transformMatrix;
+  if (preserveAspectRatioOptions) {
+    object.scaleX *= preserveAspectRatioOptions.scaleX;
+    object.scaleY *= preserveAspectRatioOptions.scaleY;
+    (object as Image).cropX = preserveAspectRatioOptions.cropX;
+    (object as Image).cropY = preserveAspectRatioOptions.cropY;
+    center.x += preserveAspectRatioOptions.offsetLeft;
+    center.y += preserveAspectRatioOptions.offsetTop;
+    object.width = preserveAspectRatioOptions.width;
+    object.height = preserveAspectRatioOptions.height;
+  }
+  object.setPositionByOrigin(center, 'center', 'center');
+};

package/src/util/types.ts

@@ -0,0 +1,78 @@
+import type { ActiveSelection } from '../shapes/ActiveSelection';
+import type { Group } from '../shapes/Group';
+import type {
+  FabricObject,
+  TCachedFabricObject,
+} from '../shapes/Object/Object';
+import type { FabricObjectWithDragSupport } from '../shapes/Object/InteractiveObject';
+import type { TFiller } from '../typedefs';
+import type { Text } from '../shapes/Text/Text';
+import type { Pattern } from '../Pattern';
+import type { IText } from '../shapes/IText/IText';
+import type { Textbox } from '../shapes/Textbox';
+
+export const isFiller = (
+  filler: TFiller | string | null
+): filler is TFiller => {
+  return !!filler && (filler as TFiller).toLive !== undefined;
+};
+
+export const isSerializableFiller = (
+  filler: TFiller | string | null
+): filler is TFiller => {
+  return !!filler && typeof (filler as TFiller).toObject === 'function';
+};
+
+export const isPattern = (filler: TFiller): filler is Pattern => {
+  return (
+    !!filler &&
+    (filler as Pattern).offsetX !== undefined &&
+    (filler as Pattern).source !== undefined
+  );
+};
+
+export const isCollection = (
+  fabricObject?: FabricObject
+): fabricObject is Group | ActiveSelection => {
+  return !!fabricObject && Array.isArray((fabricObject as Group)._objects);
+};
+
+export const isActiveSelection = (
+  fabricObject?: FabricObject
+): fabricObject is ActiveSelection => {
+  return !!fabricObject && fabricObject.type === 'activeSelection';
+};
+
+export const isTextObject = (
+  fabricObject?: FabricObject
+): fabricObject is Text => {
+  // we could use instanceof but that would mean pulling in Text code for a simple check
+  // @todo discuss what to do and how to do
+  return !!fabricObject && fabricObject.type.includes('text');
+};
+
+export const isInteractiveTextObject = (
+  fabricObject?: FabricObject
+): fabricObject is IText | Textbox => {
+  // we could use instanceof but that would mean pulling in Text code for a simple check
+  // @todo discuss what to do and how to do
+  return !!fabricObject && ['i-text', 'textbox'].includes(fabricObject.type);
+};
+
+export const isFabricObjectCached = (
+  fabricObject: FabricObject
+): fabricObject is TCachedFabricObject => {
+  return fabricObject.shouldCache() && !!fabricObject._cacheCanvas;
+};
+
+export const isFabricObjectWithDragSupport = (
+  fabricObject?: FabricObject
+): fabricObject is FabricObjectWithDragSupport => {
+  return (
+    !!fabricObject &&
+    typeof (fabricObject as FabricObjectWithDragSupport).onDragStart ===
+      'function' &&
+    typeof (fabricObject as FabricObjectWithDragSupport).shouldStartDragging ===
+      'function'
+  );
+};

package/tsconfig.json

@@ -0,0 +1,106 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Enable incremental compilation */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+    /* Modules */
+    "module": "ESNext" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    "paths": {
+      "fabric": ["./index"],
+      "fabric/node": ["./index.node"]
+    } /* Specify a set of entries that re-map imports to additional lookup locations. */,
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    "resolveJsonModule": true /* Enable importing .json files */,
+    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    "allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+    /* Emit */
+    "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
+    "declarationMap": true /* Create sourcemaps for d.ts files. */,
+    "emitDeclarationOnly": true /* Only output d.ts files and not JavaScript files. */,
+    "sourceMap": true /* Create source map files for emitted JavaScript files. */,
+    // "outFile": "",                                    /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist" /* Specify an output folder for all emitted files. */,
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+    "noEmitOnError": false /* Disable emitting files if any type checking errors are reported. */,
+    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": false /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+    "strictPropertyInitialization": false /* Check for class properties that are declared but not set in the constructor. */,
+    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  },
+  "exclude": ["dist"],
+  "include": ["src", "fabric.ts", "index.ts", "index.node.ts"]
+}

package/HEADER.js

@@ -1,203 +0,0 @@
-/*! Fabric.js Copyright 2008-2015, Printio (Juriy Zaytsev, Maxim Chernyak) */
-
-var fabric = fabric || { version: '5.3.0' };
-if (typeof exports !== 'undefined') {
-  exports.fabric = fabric;
-}
-/* _AMD_START_ */
-else if (typeof define === 'function' && define.amd) {
-  define([], function() { return fabric; });
-}
-/* _AMD_END_ */
-if (typeof document !== 'undefined' && typeof window !== 'undefined') {
-  if (document instanceof (typeof HTMLDocument !== 'undefined' ? HTMLDocument : Document)) {
-    fabric.document = document;
-  }
-  else {
-    fabric.document = document.implementation.createHTMLDocument('');
-  }
-  fabric.window = window;
-}
-else {
-  // assume we're running under node.js when document/window are not present
-  var jsdom = require('jsdom');
-  var virtualWindow = new jsdom.JSDOM(
-    decodeURIComponent('%3C!DOCTYPE%20html%3E%3Chtml%3E%3Chead%3E%3C%2Fhead%3E%3Cbody%3E%3C%2Fbody%3E%3C%2Fhtml%3E'),
-    {
-      features: {
-        FetchExternalResources: ['img']
-      },
-      resources: 'usable'
-    }).window;
-  fabric.document = virtualWindow.document;
-  fabric.jsdomImplForWrapper = require('jsdom/lib/jsdom/living/generated/utils').implForWrapper;
-  fabric.nodeCanvas = require('jsdom/lib/jsdom/utils').Canvas;
-  fabric.window = virtualWindow;
-  DOMParser = fabric.window.DOMParser;
-}
-
-/**
- * True when in environment that supports touch events
- * @type boolean
- */
-fabric.isTouchSupported = 'ontouchstart' in fabric.window || 'ontouchstart' in fabric.document ||
-  (fabric.window && fabric.window.navigator && fabric.window.navigator.maxTouchPoints > 0);
-
-/**
- * True when in environment that's probably Node.js
- * @type boolean
- */
-fabric.isLikelyNode = typeof Buffer !== 'undefined' &&
-                      typeof window === 'undefined';
-
-/* _FROM_SVG_START_ */
-/**
- * Attributes parsed from all SVG elements
- * @type array
- */
-fabric.SHARED_ATTRIBUTES = [
-  'display',
-  'transform',
-  'fill', 'fill-opacity', 'fill-rule',
-  'opacity',
-  'stroke', 'stroke-dasharray', 'stroke-linecap', 'stroke-dashoffset',
-  'stroke-linejoin', 'stroke-miterlimit',
-  'stroke-opacity', 'stroke-width',
-  'id', 'paint-order', 'vector-effect',
-  'instantiated_by_use', 'clip-path',
-];
-/* _FROM_SVG_END_ */
-
-/**
- * Pixel per Inch as a default value set to 96. Can be changed for more realistic conversion.
- */
-fabric.DPI = 96;
-fabric.reNum = '(?:[-+]?(?:\\d+|\\d*\\.\\d+)(?:[eE][-+]?\\d+)?)';
-fabric.commaWsp = '(?:\\s+,?\\s*|,\\s*)';
-fabric.rePathCommand = /([-+]?((\d+\.\d+)|((\d+)|(\.\d+)))(?:[eE][-+]?\d+)?)/ig;
-fabric.reNonWord = /[ \n\.,;!\?\-]/;
-fabric.fontPaths = { };
-fabric.iMatrix = [1, 0, 0, 1, 0, 0];
-fabric.svgNS = 'http://www.w3.org/2000/svg';
-
-/**
- * Pixel limit for cache canvases. 1Mpx , 4Mpx should be fine.
- * @since 1.7.14
- * @type Number
- * @default
- */
-fabric.perfLimitSizeTotal = 2097152;
-
-/**
- * Pixel limit for cache canvases width or height. IE fixes the maximum at 5000
- * @since 1.7.14
- * @type Number
- * @default
- */
-fabric.maxCacheSideLimit = 4096;
-
-/**
- * Lowest pixel limit for cache canvases, set at 256PX
- * @since 1.7.14
- * @type Number
- * @default
- */
-fabric.minCacheSideLimit = 256;
-
-/**
- * Cache Object for widths of chars in text rendering.
- */
-fabric.charWidthsCache = { };
-
-/**
- * if webgl is enabled and available, textureSize will determine the size
- * of the canvas backend
- * @since 2.0.0
- * @type Number
- * @default
- */
-fabric.textureSize = 2048;
-
-/**
- * When 'true', style information is not retained when copy/pasting text, making
- * pasted text use destination style.
- * Defaults to 'false'.
- * @type Boolean
- * @default
- */
-fabric.disableStyleCopyPaste = false;
-
-/**
- * Enable webgl for filtering picture is available
- * A filtering backend will be initialized, this will both take memory and
- * time since a default 2048x2048 canvas will be created for the gl context
- * @since 2.0.0
- * @type Boolean
- * @default
- */
-fabric.enableGLFiltering = true;
-
-/**
- * Device Pixel Ratio
- * @see https://developer.apple.com/library/safari/documentation/AudioVideo/Conceptual/HTML-canvas-guide/SettingUptheCanvas/SettingUptheCanvas.html
- */
-fabric.devicePixelRatio = fabric.window.devicePixelRatio ||
-                          fabric.window.webkitDevicePixelRatio ||
-                          fabric.window.mozDevicePixelRatio ||
-                          1;
-/**
- * Browser-specific constant to adjust CanvasRenderingContext2D.shadowBlur value,
- * which is unitless and not rendered equally across browsers.
- *
- * Values that work quite well (as of October 2017) are:
- * - Chrome: 1.5
- * - Edge: 1.75
- * - Firefox: 0.9
- * - Safari: 0.95
- *
- * @since 2.0.0
- * @type Number
- * @default 1
- */
-fabric.browserShadowBlurConstant = 1;
-
-/**
- * This object contains the result of arc to bezier conversion for faster retrieving if the same arc needs to be converted again.
- * It was an internal variable, is accessible since version 2.3.4
- */
-fabric.arcToSegmentsCache = { };
-
-/**
- * This object keeps the results of the boundsOfCurve calculation mapped by the joined arguments necessary to calculate it.
- * It does speed up calculation, if you parse and add always the same paths, but in case of heavy usage of freedrawing
- * you do not get any speed benefit and you get a big object in memory.
- * The object was a private variable before, while now is appended to the lib so that you have access to it and you
- * can eventually clear it.
- * It was an internal variable, is accessible since version 2.3.4
- */
-fabric.boundsOfCurveCache = { };
-
-/**
- * If disabled boundsOfCurveCache is not used. For apps that make heavy usage of pencil drawing probably disabling it is better
- * @default true
- */
-fabric.cachesBoundsOfCurve = true;
-
-/**
- * Skip performance testing of setupGLContext and force the use of putImageData that seems to be the one that works best on
- * Chrome + old hardware. if your users are experiencing empty images after filtering you may try to force this to true
- * this has to be set before instantiating the filtering backend ( before filtering the first image )
- * @type Boolean
- * @default false
- */
-fabric.forceGLPutImageData = false;
-
-fabric.initFilterBackend = function() {
-  if (fabric.enableGLFiltering && fabric.isWebglSupported && fabric.isWebglSupported(fabric.textureSize)) {
-    console.log('max texture size: ' + fabric.maxTextureSize);
-    return (new fabric.WebglFilterBackend({ tileSize: fabric.textureSize }));
-  }
-  else if (fabric.Canvas2dFilterBackend) {
-    return (new fabric.Canvas2dFilterBackend());
-  }
-};