@striae-org/striae 3.0.4

package/.env.example

@@ -0,0 +1,100 @@
+# ================================
+# STRIAE ENVIRONMENT VARIABLES EXAMPLE
+# ================================
+# Copy this file to .env and fill in your actual values
+
+# ================================
+# CLOUDFLARE CORE CONFIGURATION
+# ================================
+ACCOUNT_ID=your_cloudflare_account_id_here
+
+# ================================
+# SHARED AUTHENTICATION & STORAGE
+# ================================
+USER_DB_AUTH=your_custom_user_db_auth_token_here
+R2_KEY_SECRET=your_custom_r2_secret_here
+IMAGES_API_TOKEN=your_cloudflare_images_api_token_here
+
+# ================================
+# FIREBASE AUTH CONFIGURATION
+# ================================
+API_KEY=your_firebase_api_key_here
+AUTH_DOMAIN=your_firebase_auth_domain_here
+PROJECT_ID=your_firebase_project_id_here
+STORAGE_BUCKET=your_firebase_storage_bucket_here
+MESSAGING_SENDER_ID=your_firebase_messaging_sender_id_here
+APP_ID=your_firebase_app_id_here
+MEASUREMENT_ID=your_firebase_measurement_id_here
+
+# ===============================
+# FIREBASE SERVICE ACCOUNT CONFIGURATION
+# ===============================
+# **PULLED FROM ADMIN-SERVICE.JSON FILE ONLY**
+PROJECT_ID=your_firebase_project_id_here
+FIREBASE_SERVICE_ACCOUNT_EMAIL=your_firebase_service_account_email_here
+FIREBASE_SERVICE_ACCOUNT_PRIVATE_KEY=your_firebase_service_account_private_key_here
+
+# ================================
+# PAGES WORKER ENVIRONMENT VARIABLES
+# ================================
+PAGES_PROJECT_NAME=your_pages_project_name_here
+PAGES_CUSTOM_DOMAIN=your_custom_domain_here
+
+# ================================
+# KEYS WORKER ENVIRONMENT VARIABLES
+# ================================
+KEYS_WORKER_NAME=your_keys_worker_name_here
+KEYS_WORKER_DOMAIN=your_keys_worker_domain_here
+KEYS_AUTH=your_custom_keys_auth_token_here
+ACCOUNT_HASH=your_cloudflare_images_account_hash_here
+
+# ================================
+# USER WORKER ENVIRONMENT VARIABLES  
+# ================================
+USER_WORKER_NAME=your_user_worker_name_here
+USER_WORKER_DOMAIN=your_user_worker_domain_here
+KV_STORE_ID=your_kv_store_id_here
+
+# ================================
+# DATA WORKER ENVIRONMENT VARIABLES
+# ================================
+DATA_WORKER_NAME=your_data_worker_name_here
+DATA_BUCKET_NAME=your_data_bucket_name_here
+DATA_WORKER_DOMAIN=your_data_worker_domain_here
+# Auto-generated by scripts/deploy-config.sh when placeholders are detected.
+MANIFEST_SIGNING_PRIVATE_KEY=your_manifest_signing_private_key_here
+MANIFEST_SIGNING_KEY_ID=forensic-signing-key-v1
+MANIFEST_SIGNING_PUBLIC_KEY=your_manifest_signing_public_key_here
+
+# ================================
+# AUDIT WORKER ENVIRONMENT VARIABLES
+# ================================
+AUDIT_WORKER_NAME=your_audit_worker_name_here
+AUDIT_BUCKET_NAME=your_audit_bucket_name_here
+AUDIT_WORKER_DOMAIN=your_audit_worker_domain_here
+
+# ================================
+# IMAGES WORKER ENVIRONMENT VARIABLES
+# ================================
+IMAGES_WORKER_NAME=your_images_worker_name_here
+IMAGES_WORKER_DOMAIN=your_images_worker_domain_here
+API_TOKEN=your_cloudflare_images_api_token_here
+HMAC_KEY=your_cloudflare_images_hmac_key_here
+
+# ================================
+# PDF WORKER ENVIRONMENT VARIABLES
+# ================================
+PDF_WORKER_NAME=your_pdf_worker_name_here
+PDF_WORKER_DOMAIN=your_pdf_worker_domain_here
+
+# ================================
+# QUICK MANUAL SETUP CHECKLIST
+# ================================
+# □ Copy this file to .env
+# □ Fill in all Cloudflare credentials
+# □ Generate secure random tokens for custom auth
+# □ Set environment variables in each worker's Cloudflare Dashboard
+# □ Set environment variables in Pages Dashboard
+# □ Configure KV binding in user-worker/wrangler.jsonc
+# □ Configure R2 binding in data-worker/wrangler.jsonc
+# □ Configure R2 binding in audit-worker/wrangler.jsonc

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS  
+
+   Striae © 2025. All rights reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,18 @@
+NOTICE
+
+Striae – A Firearms Examiner’s Comparison Companion
+
+Striae © 2025. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License in the repository’s LICENSE file.
+
+This product includes software developed by Stephen J. Lu.
+
+Attributions for bundled components:
+
+Portions of this product may include open-source software licensed under their respective licenses, including but not limited to: Remix, Cloudflare Workers, Firebase, Tailwind CSS, Vite, and other npm packages. License texts for third-party components are provided in their respective source files or in node_modules as applicable.
+
+No trademark rights are granted for “Striae” or any associated names or logos.
+
+The background image used in the application landing page and marketing materials is sourced from:
+Mattijssen, Erwin & Kerkhoff, Wim & Berger, Charles & Dror, Itiel & Stoel, Reinoud. (2016). Implementing context information management in forensic casework: Minimizing contextual bias in firearms examination. Science & Justice. 56. 113-122. <https://www.researchgate.net/publication/288700798_Implementing_context_information_management_in_forensic_casework_Minimizing_contextual_bias_in_firearms_examination>.

package/README.md

@@ -0,0 +1,133 @@
+# @striae-org/striae
+
+Striae is a cloud-native forensic annotation application for firearms identification, built with Remix and Cloudflare Workers.
+
+This npm package publishes the Striae application source and deployment scaffolding for teams that run their own Striae environment.
+
+## Live Project
+
+- Application: [https://www.striae.org](https://www.striae.org)
+- Source repository: [https://github.com/striae-org/striae](https://github.com/striae-org/striae)
+- Releases: [https://github.com/striae-org/striae/releases](https://github.com/striae-org/striae/releases)
+- Security policy: [https://github.com/striae-org/striae/security/policy](https://github.com/striae-org/striae/security/policy)
+
+## What This Package Is
+
+- A deployable source distribution of Striae app code.
+- A package that includes worker examples and example configuration files.
+
+## What This Package Is Not
+
+- Not a small client SDK.
+- Not a zero-config, ready-to-run desktop app.
+
+## npm Package, Installation, and Full Deployment
+
+**Striae Package Links**
+
+- npmjs: [https://www.npmjs.com/package/@striae-org/striae](https://www.npmjs.com/package/@striae-org/striae)
+- GitHub Packages: [https://github.com/orgs/striae-org/packages/npm/package/striae](https://github.com/orgs/striae-org/packages/npm/package/striae)
+
+1) Install the latest package:
+
+```bash
+npm i @striae-org/striae
+```
+
+2) Copy the package scaffold into the project root
+
+```bash
+cp -R node_modules/@striae-org/striae/. .
+```
+
+3) Reinstall using Striae's own package.json (includes dev deps like wrangler/remix)
+
+```bash
+rm -rf node_modules package-lock.json
+npm install
+```
+
+4) Prepare Firebase admin credentials (required before deploy-config can pass)
+
+```bash
+mkdir -p app/config
+cp -f app/config-example/admin-service.json app/config/admin-service.json
+```
+
+5) Replace `app/config/admin-service.json` with your actual Firebase service account JSON
+
+6) Authenticate Cloudflare CLI
+
+```bash
+npx wrangler login
+```
+
+6) Run guided config + full deployment
+
+```bash
+npm run deploy:all
+```
+
+## Publish To npmjs And GitHub Packages
+
+1) Verify auth for both registries
+
+```bash
+npm whoami --registry=https://registry.npmjs.org/
+npm whoami --registry=https://npm.pkg.github.com/
+```
+
+2) Publish current version to npmjs (public)
+
+```bash
+npm run publish:npm
+```
+
+3) Publish the same version to GitHub Packages
+
+```bash
+npm run publish:github
+```
+
+4) Optional dry-runs before a real release
+
+```bash
+npm run publish:npm:dry-run
+npm run publish:github:dry-run
+npm run publish:all:dry-run
+```
+
+## NPM Package Content Policy
+
+This package intentionally includes only non-sensitive defaults and runtime source needed for setup.
+
+Included:
+
+- `app/` source (with `app/config-example/`)
+- `functions/`, `public/`, `scripts/`
+- Worker package manifests
+- Worker source files except runtime entry files (`workers/*/src/*.ts` and excluding `workers/*/src/*worker.ts`)
+- Worker example Wrangler configs (`workers/*/wrangler.jsonc.example`)
+- Project-level example and build config (`.env.example`, `wrangler.toml.example`, `tsconfig.json`, etc.)
+
+Excluded (by design):
+
+- Real runtime config under `app/config/`
+- Real worker config files (for example `workers/*/wrangler.jsonc`)
+- Local secrets and machine-specific files
+- Extra repository metadata not required for npm consumers
+
+## Security Notes
+
+- Do not commit secrets to `app/config/`, `.env`, or worker config files.
+- Use only example files as templates and provide real values in your own private environment.
+- Review release notes for security updates before deployment.
+
+## License
+
+See `LICENSE` and `NOTICE`.
+
+## Support
+
+- Support page: [https://www.striae.org/support](https://www.striae.org/support)
+- Contact: [info@striae.org](mailto:info@striae.org)