@smallpen/local-package 0.1.0-alpha.3 → 0.1.0-alpha.8

package/assets/fonts/SourceSansPro-OFL.txt

@@ -0,0 +1,46 @@
+Applies to: SourceSansPro-Regular.ttf, SourceSansPro-Semibold.ttf, SourceSansPro-Bold.ttf
+
+Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+
+This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide development of collaborative font projects, to support the font creation efforts of academic and linguistic communities, and to provide a free and open framework in which fonts may be shared and improved in partnership with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and redistributed freely as long as they are not sold by themselves. The fonts, including any derivative works, can be bundled, embedded, redistributed and/or sold with any software provided that any reserved names are not used by derivative works. The fonts and derivatives, however, cannot be released under any other type of license. The requirement for fonts to remain under this license does not apply to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright Holder(s) under this license and clearly marked as such. This may include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting, or substituting -- in part or in whole -- any of the components of the Original Version, by changing formats or by porting the Font Software to a new environment.
+
+"Author" refers to any designer, engineer, programmer, technical writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining a copy of the Font Software, to use, study, copy, merge, embed, modify, redistribute, and sell modified and unmodified copies of the Font Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components, in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled, redistributed and/or sold with any software, provided that each copy contains the above copyright notice and this license. These can be included either as stand-alone text files, human-readable headers or in the appropriate machine-readable metadata fields within text or binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font Name(s) unless explicit written permission is granted by the corresponding Copyright Holder. This restriction only applies to the primary font name as presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font Software shall not be used to promote, endorse or advertise any Modified Version, except to acknowledge the contribution(s) of the Copyright Holder(s) and the Author(s) or with their explicit written permission.
+
+5) The Font Software, modified or unmodified, in part or in whole, must be distributed entirely under this license, and must not be distributed under any other license. The requirement for fonts to remain under this license does not apply to any document created using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.

package/assets/fonts/WorkSans-OFL.txt

@@ -0,0 +1,46 @@
+Applies to: WorkSans-Regular.ttf
+
+Copyright 2019 The Work Sans Project Authors (https://github.com/weiweihuanghuang/Work-Sans)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide development of collaborative font projects, to support the font creation efforts of academic and linguistic communities, and to provide a free and open framework in which fonts may be shared and improved in partnership with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and redistributed freely as long as they are not sold by themselves. The fonts, including any derivative works, can be bundled, embedded, redistributed and/or sold with any software provided that any reserved names are not used by derivative works. The fonts and derivatives, however, cannot be released under any other type of license. The requirement for fonts to remain under this license does not apply to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright Holder(s) under this license and clearly marked as such. This may include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting, or substituting -- in part or in whole -- any of the components of the Original Version, by changing formats or by porting the Font Software to a new environment.
+
+"Author" refers to any designer, engineer, programmer, technical writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining a copy of the Font Software, to use, study, copy, merge, embed, modify, redistribute, and sell modified and unmodified copies of the Font Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components, in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled, redistributed and/or sold with any software, provided that each copy contains the above copyright notice and this license. These can be included either as stand-alone text files, human-readable headers or in the appropriate machine-readable metadata fields within text or binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font Name(s) unless explicit written permission is granted by the corresponding Copyright Holder. This restriction only applies to the primary font name as presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font Software shall not be used to promote, endorse or advertise any Modified Version, except to acknowledge the contribution(s) of the Copyright Holder(s) and the Author(s) or with their explicit written permission.
+
+5) The Font Software, modified or unmodified, in part or in whole, must be distributed entirely under this license, and must not be distributed under any other license. The requirement for fonts to remain under this license does not apply to any document created using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smallpen/local-package",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-alpha.8",
   "publishConfig": {
     "access": "public"
   },
@@ -12,7 +12,7 @@
   ],
   "dependencies": {
     "@jsquash/webp": "1.5.0",
-    "@smallpen/core": "0.1.0-alpha.3",
+    "@smallpen/core": "0.1.0-alpha.8",
     "opentype.js": "2.0.0"
   },
   "repository": {

package/src/draft-import.mjs

@@ -1,6 +1,5 @@
 import { randomUUID } from "node:crypto";
 import {
-  lstat,
   mkdir,
   mkdtemp,
   rename,
@@ -21,6 +20,7 @@ import {
   SmallPenError,
 } from "@smallpen/core";
 
+import { pathExists } from "./fs-utils.mjs";
 import {
   ByteBuffer,
   compileSchema,
@@ -170,16 +170,6 @@ function inspectSvg(bytes) {
   return { height, width };
 }
 
-async function pathExists(path) {
-  try {
-    await lstat(path);
-    return true;
-  } catch (error) {
-    if (error?.code === "ENOENT") return false;
-    throw error;
-  }
-}
-
 export async function writeDraftPackage(outputValue, values) {
   const output = resolve(outputValue);
   if (!output.endsWith(".smallpen")) {

package/src/font-convert.mjs

@@ -20,7 +20,9 @@ function matches(bytes, signature) {
 }
 
 export function inspectFont(bytes, mimeType) {
-  const signature = FONT_SIGNATURES[mimeType];
+  const signature = Object.hasOwn(FONT_SIGNATURES, mimeType)
+    ? FONT_SIGNATURES[mimeType]
+    : undefined;
   if (!signature || !matches(bytes, signature)) {
     failFont(
       "invalid_font_blob",
@@ -108,6 +110,26 @@ export function sfntToWoff(bytes, mimeType) {
   return output;
 }
 
+// Penpot names a Font Variant without a stored name from its weight and
+// style (app.common.media/font-display-variant), e.g. "Bold Italic".
+const FONT_WEIGHT_NAMES = {
+  100: "Hairline",
+  200: "Extra Light",
+  300: "Light",
+  400: "Regular",
+  500: "Medium",
+  600: "Semi Bold",
+  700: "Bold",
+  800: "Extra Bold",
+  900: "Black",
+  950: "Extra Black",
+};
+
+export function fontVariantName(weight, style) {
+  const base = FONT_WEIGHT_NAMES[Number(weight)] ?? String(weight);
+  return style === "italic" ? `${base} Italic` : base;
+}
+
 export function prepareFontFiles(input) {
   const files = {};
   for (const [mimeType, bytes] of Object.entries(input)) {

package/src/fs-utils.mjs

@@ -0,0 +1,95 @@
+import { constants } from "node:fs";
+import { lstat, open } from "node:fs/promises";
+import { isAbsolute, relative } from "node:path";
+
+export function isWithinRoot(rootPath, candidatePath) {
+  const child = relative(rootPath, candidatePath);
+  return child === "" || (!child.startsWith("..") && !isAbsolute(child));
+}
+
+export async function pathExists(path) {
+  try {
+    await lstat(path);
+    return true;
+  } catch (error) {
+    if (error?.code === "ENOENT") return false;
+    throw error;
+  }
+}
+
+// Reads a file only when it is a regular file. A FIFO or device in a Package
+// (an archive can carry one) would otherwise block the read, the write lock
+// and a thread-pool thread forever. Opening without blocking and checking the
+// opened handle leaves no gap between the check and the read.
+//
+// With `maxBytes`, a file larger than the limit fails with code EFILETOOBIG
+// (and `size`/`maxBytes` on the error) instead of being buffered whole; the
+// read itself is bounded too, so a file growing after the size check cannot
+// pass the limit either.
+export async function readRegularFile(path, encoding, { maxBytes } = {}) {
+  const handle = await open(path, constants.O_RDONLY | (constants.O_NONBLOCK ?? 0));
+  try {
+    const info = await handle.stat();
+    if (!info.isFile()) {
+      const error = new Error(`Not a regular file: ${path}`);
+      error.code = "ENOTREGULAR";
+      throw error;
+    }
+    if (maxBytes === undefined) return await handle.readFile(encoding);
+    const tooBig = (size) =>
+      Object.assign(new Error(`File exceeds ${maxBytes} bytes: ${path}`), {
+        code: "EFILETOOBIG",
+        maxBytes,
+        size,
+      });
+    if (info.size > maxBytes) throw tooBig(info.size);
+    const chunks = [];
+    let length = 0;
+    while (length <= maxBytes) {
+      const chunk = Buffer.alloc(Math.min(Math.max(info.size - length, 0), maxBytes - length) + 1);
+      const { bytesRead } = await handle.read(chunk, 0, chunk.length, length);
+      if (bytesRead === 0) break;
+      chunks.push(chunk.subarray(0, bytesRead));
+      length += bytesRead;
+    }
+    if (length > maxBytes) throw tooBig(length);
+    const bytes = Buffer.concat(chunks, length);
+    return encoding ? bytes.toString(encoding) : bytes;
+  } finally {
+    await handle.close();
+  }
+}
+
+// Writes a new file and flushes it to stable storage before returning. The
+// file must not exist yet: commits never truncate an inode in place because
+// unchanged candidate files are hard links shared with the live Package.
+export async function writeFileDurable(path, data, encoding) {
+  const handle = await open(path, "wx");
+  try {
+    await handle.writeFile(data, encoding);
+    await handle.sync();
+  } finally {
+    await handle.close();
+  }
+}
+
+// Flushes directory entries (creates, renames, unlinks). Some platforms and
+// file systems (notably Windows) cannot open or sync a directory; durability
+// there relies on the file-level syncs alone.
+export async function syncDirectory(path) {
+  let handle;
+  try {
+    handle = await open(path, "r");
+    await handle.sync();
+  } catch (error) {
+    if (
+      !["EISDIR", "EPERM", "EACCES", "EINVAL", "ENOTSUP", "EBADF"].includes(
+        error?.code,
+      )
+    ) {
+      throw error;
+    }
+  } finally {
+    await handle?.close();
+  }
+}

package/src/index.mjs

@@ -3,18 +3,31 @@ export {
   LocalWorkspaceSession,
   reconcilePackageViewState,
 } from "./local-workspace-session.mjs";
-export { openWorkspace, resolveWorkspace } from "./workspace.mjs";
+export {
+  localLibraryLocator,
+  openWorkspace,
+  resolveWorkspace,
+} from "./workspace.mjs";
 export {
   defaultLibraryCacheRoot,
   openRemoteLibrary,
 } from "./remote-library.mjs";
-export { createEvidence, renderProjection } from "./render.mjs";
+export {
+  createEvidence,
+  measureProjectionText,
+  renderProjection,
+} from "./render.mjs";
 export {
   decodeFigmaClipboard,
   importDraft,
   writeDraftPackage,
 } from "./draft-import.mjs";
-export { createBlankPackage, initializeWorkspace } from "./initialize.mjs";
+export {
+  createBlankPackage,
+  initializeBlankWorkspace,
+  initializeWorkspace,
+} from "./initialize.mjs";
+export { migrateThemesByCopy } from "./migrate-themes.mjs";
 export {
   applyOperationBatch,
   deleteFontFamily,
@@ -22,12 +35,14 @@ export {
   importFontVariant,
   importMedia,
   openPackage,
+  readBatchHistory,
   removeMedia,
   replayRecordedBatch,
   updateFontFamily,
 } from "./local-package.mjs";
 export { detectMediaType, inspectMedia } from "./media-inspect.mjs";
 export {
+  fontVariantName,
   inspectFont,
   prepareFontFiles,
   sfntToWoff,