@sheetxl/workbook-templates 0.1.0

package/LICENSE

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

package/README.md

@@ -0,0 +1,112 @@
+# Workbook Templates
+
+![SheetXL](https://www.sheetxl.com/logo-text.svg)
+
+[![License: CC0-1.0](https://img.shields.io/badge/license-CC0--1.0-blue.svg)](LICENSE)
+[![Discord](https://img.shields.io/discord/1141404921246257223)](https://discord.gg/NTKdwUgK9p)
+
+## Overview
+
+The workbook templates that appear in the SheetXL **New Workbook** gallery. The repo is published to
+npm as [`@sheetxl/workbook-templates`](https://www.npmjs.com/package/@sheetxl/workbook-templates),
+and the SheetXL studio reads the catalog straight from unpkg:
+
+```text
+https://unpkg.com/@sheetxl/workbook-templates/dist/workbook-templates/contents.json
+```
+
+Every template is original content, dedicated to the public domain under [CC0 1.0](LICENSE). Use
+them however you like.
+
+## Adding a template
+
+Drop an `.xlsx` into a category folder under `templates/` and open a pull request. That is all. CI
+validates the workbook, builds the index and publishes it.
+
+- **The file name is the title.** `yearly-calendar.xlsx` is shown as "Yearly Calendar". Use
+  lowercase-kebab-case names.
+- **The folder is the category.** Use an existing folder, or create a new one. There is one level
+  only; an `.xlsx` directly in `templates/` fails the build.
+- **Thumbnails come from CI.** You do not need to make one. CI opens each template in the pinned
+  SheetXL studio (`render/`) and photographs its first screen. A hand-made `<name>.png` beside the
+  template is used instead, for a template whose first screen is not its best.
+
+To check a template before you push, run `npm install` and `npm run build`. To see its thumbnail,
+run `npx playwright install chromium` once, then `npm run thumbnails` before the build; the images
+land in `.thumbnails/`.
+
+Templates must be your own work, or carry a license that allows redistribution under CC0. Do not
+submit Microsoft Office templates or close copies of them.
+
+## Layout
+
+```text
+templates/
+  <category>/
+    _category.json        optional: { "title", "description", "order", "icon" }
+    <name>.xlsx           a template
+    <name>.png            optional hand-made thumbnail
+config/thumbnails.ts      renders .thumbnails/<category>/<name>.webp for each template
+config/build.ts           validates every template, then writes dist/
+render/                   the page that renders one template for its thumbnail
+```
+
+A category folder's `_category.json` sets its display title, description, sort `order` and icon.
+Without one, the title comes from the folder name ("project-management" becomes "Project
+Management"). Categories sort by `order`, then by title. Templates sort by title within a category.
+
+The build writes:
+
+```text
+dist/contents.json                                root listing of every file and folder
+dist/workbook-templates/contents.json             the catalog
+dist/workbook-templates/<category>/<name>.xlsx
+dist/workbook-templates/<category>/<name>.webp    the rendered thumbnail, or a hand-made .png
+```
+
+The catalog looks like this. Entry paths are relative to `dist/workbook-templates/`.
+
+```jsonc
+{
+  "kind": "templates",
+  "package": "workbook-templates",
+  "meta": {
+    "schema": 1,
+    "categories": [{ "id": "finance", "title": "Finance", "description": "..." }]
+  },
+  "entries": [
+    { "path": "finance/loan-calculator.xlsx", "category": "finance", "title": "Loan Calculator" }
+  ]
+}
+```
+
+## What the build checks
+
+Each `.xlsx` must open in the SheetXL SDK and fully recalculate with no `#NAME?` in any cell. The
+build also fails on a template that contains any of:
+
+- SheetXL script modules;
+- a VBA project;
+- links to other workbooks;
+- `WEBSERVICE`, `FILTERXML`, `IMPORTDATA` or another function that fetches from the network;
+- a hyperlink that is not `https:`;
+- more than 2 MB.
+
+Any other file in a category folder, besides `_category.json` and thumbnails, also fails the build.
+
+## Publishing
+
+A push to `main` that changes `templates/` or `config/` builds the catalog, bumps the patch version,
+tags it, publishes to npm and creates a GitHub release. Put `[publish]` in the commit message to
+publish without a template change.
+
+## Additional Resources
+
+- **[Main GitHub](https://github.com/sheetxl)**
+- **[Discord](https://discord.gg/NTKdwUgK9p)**
+- **[Website](https://www.sheetxl.com)**
+- **[Developer Docs](https://www.sheetxl.com/docs)**
+
+## License
+
+The templates are dedicated to the public domain under [CC0 1.0 Universal](LICENSE).

package/dist/contents.json

@@ -0,0 +1,37 @@
+{
+  "entries": [
+    {
+      "path": "workbook-templates/contents.json"
+    },
+    {
+      "path": "workbook-templates/finance/loan-calculator.webp"
+    },
+    {
+      "path": "workbook-templates/finance/loan-calculator.xlsx"
+    },
+    {
+      "path": "workbook-templates/finance/monthly-budget.webp"
+    },
+    {
+      "path": "workbook-templates/finance/monthly-budget.xlsx"
+    },
+    {
+      "path": "workbook-templates/lifestyle/habit-tracker.webp"
+    },
+    {
+      "path": "workbook-templates/lifestyle/habit-tracker.xlsx"
+    },
+    {
+      "path": "workbook-templates/project-management/simple-task-list.webp"
+    },
+    {
+      "path": "workbook-templates/project-management/simple-task-list.xlsx"
+    }
+  ],
+  "folders": [
+    "workbook-templates",
+    "workbook-templates/finance",
+    "workbook-templates/lifestyle",
+    "workbook-templates/project-management"
+  ]
+}

package/dist/workbook-templates/contents.json

@@ -0,0 +1,50 @@
+{
+  "kind": "templates",
+  "package": "workbook-templates",
+  "meta": {
+    "schema": 1,
+    "categories": [
+      {
+        "id": "finance",
+        "title": "Finance",
+        "description": "Budgets, loans and other money math."
+      },
+      {
+        "id": "lifestyle",
+        "title": "Lifestyle",
+        "description": "Everyday planning and personal tracking."
+      },
+      {
+        "id": "project-management",
+        "title": "Project Management",
+        "description": "Plan work and keep track of who is doing what."
+      }
+    ]
+  },
+  "entries": [
+    {
+      "path": "finance/loan-calculator.xlsx",
+      "category": "finance",
+      "title": "Loan Calculator",
+      "thumbnail": "finance/loan-calculator.webp"
+    },
+    {
+      "path": "finance/monthly-budget.xlsx",
+      "category": "finance",
+      "title": "Monthly Budget",
+      "thumbnail": "finance/monthly-budget.webp"
+    },
+    {
+      "path": "lifestyle/habit-tracker.xlsx",
+      "category": "lifestyle",
+      "title": "Habit Tracker",
+      "thumbnail": "lifestyle/habit-tracker.webp"
+    },
+    {
+      "path": "project-management/simple-task-list.xlsx",
+      "category": "project-management",
+      "title": "Simple Task List",
+      "thumbnail": "project-management/simple-task-list.webp"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@sheetxl/workbook-templates",
+  "version": "0.1.0",
+  "description": "Workbook templates for the SheetXL New Workbook gallery",
+  "type": "module",
+  "main": "dist/workbook-templates/contents.json",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "build": "ts-node config/build.ts",
+    "thumbnails": "ts-node config/thumbnails.ts",
+    "prebuild": "npm run clean",
+    "clean": "ts-node config/clean.ts",
+    "typecheck": "tsc -p .",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "sheetxl",
+    "templates",
+    "spreadsheet",
+    "workbook",
+    "xlsx"
+  ],
+  "author": "SheetXL Team",
+  "license": "CC0-1.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sheetxl/workbook-templates.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sheetxl/workbook-templates/issues"
+  },
+  "homepage": "https://github.com/sheetxl/workbook-templates#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@emotion/cache": "^11.14.0",
+    "@emotion/react": "^11.14.0",
+    "@emotion/styled": "^11.14.1",
+    "@mui/material": "^9.4.0",
+    "@mui/styled-engine": "^9.4.0",
+    "@mui/system": "^9.4.0",
+    "@mui/utils": "^9.4.0",
+    "@sheetxl/io": "0.8.0-beta.1",
+    "@sheetxl/sdk": "0.8.0-beta.1",
+    "@sheetxl/studio-mui": "0.8.0-beta.1",
+    "@types/node": "^24.3.0",
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "@vitejs/plugin-react": "^6.1.1",
+    "playwright": "1.63.0",
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0",
+    "sharp": "^0.34.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.0",
+    "vite": "^8.3.0"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}