@kitaris/emdash-environment-indicator 0.0.0-stage → 0.1.0

package/LICENSE.md

@@ -0,0 +1,377 @@
+block-layouts-js
+
+Copyright (C) 2026 Built North
+
+This program is free software; you can redistribute it and/or modify it under the terms of the
+GNU General Public License as published by the Free Software Foundation; either version 2 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+It bundles and builds on WordPress Gutenberg packages (@wordpress/*), which are
+GPL-2.0-or-later. Copyright 2016-2026 by the Gutenberg contributors.
+
+---
+
+## GNU General Public License, Version 2
+
+### GNU GENERAL PUBLIC LICENSE
+
+Version 2, June 1991
+
+    Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+    51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+
+    Everyone is permitted to copy and distribute verbatim copies
+    of this license document, but changing it is not allowed.
+
+### Preamble
+
+The licenses for most software are designed to take away your freedom
+to share and change it. By contrast, the GNU General Public License is
+intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if
+you distribute copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on,
+we want its recipients to know that what they have is not the
+original, so that any problems introduced by others will not reflect
+on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at
+all.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+### TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+**0.** This License applies to any program or other work which
+contains a notice placed by the copyright holder saying it may be
+distributed under the terms of this General Public License. The
+"Program", below, refers to any such program or work, and a "work
+based on the Program" means either the Program or any derivative work
+under copyright law: that is to say, a work containing the Program or
+a portion of it, either verbatim or with modifications and/or
+translated into another language. (Hereinafter, translation is
+included without limitation in the term "modification".) Each licensee
+is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the Program
+(independent of having been made by running the Program). Whether that
+is true depends on what the Program does.
+
+**1.** You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a
+fee.
+
+**2.** You may modify your copy or copies of the Program or any
+portion of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+**a)** You must cause the modified files to carry prominent notices
+stating that you changed the files and the date of any change.
+
+**b)** You must cause any work that you distribute or publish, that in
+whole or in part contains or is derived from the Program or any part
+thereof, to be licensed as a whole at no charge to all third parties
+under the terms of this License.
+
+**c)** If the modified program normally reads commands interactively
+when run, you must cause it, when started running for such interactive
+use in the most ordinary way, to print or display an announcement
+including an appropriate copyright notice and a notice that there is
+no warranty (or else, saying that you provide a warranty) and that
+users may redistribute the program under these conditions, and telling
+the user how to view a copy of this License. (Exception: if the
+Program itself is interactive but does not normally print such an
+announcement, your work based on the Program is not required to print
+an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+**3.** You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+**a)** Accompany it with the complete corresponding machine-readable
+source code, which must be distributed under the terms of Sections 1
+and 2 above on a medium customarily used for software interchange; or,
+
+**b)** Accompany it with a written offer, valid for at least three
+years, to give any third party, for a charge no more than your cost of
+physically performing source distribution, a complete machine-readable
+copy of the corresponding source code, to be distributed under the
+terms of Sections 1 and 2 above on a medium customarily used for
+software interchange; or,
+
+**c)** Accompany it with the information you received as to the offer
+to distribute corresponding source code. (This alternative is allowed
+only for noncommercial distribution and only if you received the
+program in object code or executable form with such an offer, in
+accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+**4.** You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt otherwise
+to copy, modify, sublicense or distribute the Program is void, and
+will automatically terminate your rights under this License. However,
+parties who have received copies, or rights, from you under this
+License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+**5.** You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+**6.** Each time you redistribute the Program (or any work based on
+the Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+**7.** If, as a consequence of a court judgment or allegation of
+patent infringement or for any other reason (not limited to patent
+issues), conditions are imposed on you (whether by court order,
+agreement or otherwise) that contradict the conditions of this
+License, they do not excuse you from the conditions of this License.
+If you cannot distribute so as to satisfy simultaneously your
+obligations under this License and any other pertinent obligations,
+then as a consequence you may not distribute the Program at all. For
+example, if a patent license would not permit royalty-free
+redistribution of the Program by all those who receive copies directly
+or indirectly through you, then the only way you could satisfy both it
+and this License would be to refrain entirely from distribution of the
+Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+**8.** If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+**9.** The Free Software Foundation may publish revised and/or new
+versions of the General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Program does not specify a
+version number of this License, you may choose any version ever
+published by the Free Software Foundation.
+
+**10.** If you wish to incorporate parts of the Program into other
+free programs whose distribution conditions are different, write to
+the author to ask for permission. For software which is copyrighted by
+the Free Software Foundation, write to the Free Software Foundation;
+we sometimes make exceptions for this. Our decision will be guided by
+the two goals of preserving the free status of all derivatives of our
+free software and of promoting the sharing and reuse of software
+generally.
+
+**NO WARRANTY**
+
+**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+**12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+### END OF TERMS AND CONDITIONS
+
+### How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    one line to give the program's name and an idea of what it does.
+    Copyright (C) yyyy  name of author
+
+    This program is free software; you can redistribute it and/or
+    modify it under the terms of the GNU General Public License
+    as published by the Free Software Foundation; either version 2
+    of the License, or (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+Also add information on how to contact you by electronic and paper
+mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
+    type `show w'.  This is free software, and you are welcome
+    to redistribute it under certain conditions; type `show c'
+    for details.
+
+The hypothetical commands \`show w' and \`show c' should show the
+appropriate parts of the General Public License. Of course, the
+commands you use may be called something other than \`show w' and
+\`show c'; they could even be mouse-clicks or menu items--whatever
+suits your program.
+
+You should also get your employer (if you work as a programmer) or
+your school, if any, to sign a "copyright disclaimer" for the program,
+if necessary. Here is a sample; alter the names:
+
+    Yoyodyne, Inc., hereby disclaims all copyright
+    interest in the program `Gnomovision'
+    (which makes passes at compilers) written
+    by James Hacker.
+
+    signature of Ty Coon, 1 April 1989
+    Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library,
+you may consider it more useful to permit linking proprietary
+applications with the library. If this is what you want to do, use the
+[GNU Lesser General Public
+License](http://www.gnu.org/licenses/lgpl.html) instead of this
+License.
+
+---
+

package/README.md

@@ -1,3 +1,33 @@
-# Temporary Holding Version
+# @kitaris/emdash-environment-indicator
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An [EmDash](https://github.com/emdash-cms/emdash) plugin that shows which environment a site is on the
+dashboard: **Development**, **Staging** or **Production**, so nobody edits the live site thinking it's
+staging (or the other way round).
+
+## Install
+
+```sh
+pnpm add @kitaris/emdash-environment-indicator
+```
+
+```js
+// astro.config.mjs
+import { environmentIndicator } from "@kitaris/emdash-environment-indicator";
+
+emdash({
+	// ...
+	plugins: [environmentIndicator()],
+});
+```
+
+## How it knows
+
+1. **`EMDASH_ENVIRONMENT`**, if the deployment sets it: `development` (or `dev`, `local`), `staging`
+   (`stage`, `preview`) or `production` (`prod`, `live`). Read when the plugin runs in-process.
+2. Otherwise **the site's hostname**, against the hostnames in the plugin's settings (Plugins →
+   environment-indicator → Settings): production first, then staging, then development. One per line;
+   `*` matches any part, e.g. `*.staging.example.com`.
+3. Local hostnames (`localhost`, `127.0.0.1`, `*.localhost`, `*.local`, `*.test`) are development.
+4. Anything else is production.
+
+The widget says how it decided, e.g. "From the hostname staging.example.com, in the plugin's settings."

package/dist/detect.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Which environment a site is running in: development, staging or production. From an explicit
+ * variable when the deployment sets one (EMDASH_ENVIRONMENT), else from the site's hostname: the
+ * hostnames configured for each environment, then common local ones, else production.
+ *
+ * Plain data, no dependencies.
+ */
+export type Environment = "development" | "staging" | "production";
+export interface HostRules {
+    development?: string;
+    staging?: string;
+    production?: string;
+}
+export interface Detection {
+    environment: Environment;
+    /** How it was decided, for the widget to say. */
+    source: "variable" | "hostname" | "local hostname" | "default";
+    /** What matched: the variable's value, or the hostname pattern. Absent for "default". */
+    match?: string;
+}
+/** Hostnames that are local unless configured otherwise. */
+export declare const LOCAL_HOSTS: string[];
+/** An environment named in the variable, or undefined (unset or not a name it knows). */
+export declare function environmentFromVariable(value: string | undefined): Environment | undefined;
+/** Hostname patterns from a setting: one per line or comma separated; `*` matches any part. */
+export declare function parsePatterns(value: string | undefined): string[];
+/** Whether a hostname matches a pattern such as `staging.example.com` or `*.staging.example.com`. */
+export declare function matchesHost(hostname: string, pattern: string): boolean;
+/**
+ * The environment, from the variable if it names one, else the hostname: configured production, then
+ * staging, then development hostnames, then common local ones; anything else is production.
+ */
+export declare function detectEnvironment({ variable, hostname, rules }: {
+    variable?: string;
+    hostname: string;
+    rules?: HostRules;
+}): Detection;
+//# sourceMappingURL=detect.d.ts.map

package/dist/detect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detect.d.ts","sourceRoot":"","sources":["../src/detect.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,SAAS,GAAG,YAAY,CAAC;AAEnE,MAAM,WAAW,SAAS;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACzB,WAAW,EAAE,WAAW,CAAC;IACzB,iDAAiD;IACjD,MAAM,EAAE,UAAU,GAAG,UAAU,GAAG,gBAAgB,GAAG,SAAS,CAAC;IAC/D,yFAAyF;IACzF,KAAK,CAAC,EAAE,MAAM,CAAC;CACf;AAED,4DAA4D;AAC5D,eAAO,MAAM,WAAW,UAA0E,CAAC;AAenG,yFAAyF;AACzF,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,CAE1F;AAED,+FAA+F;AAC/F,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,EAAE,CAKjE;AAED,qGAAqG;AACrG,wBAAgB,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAGtE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAU,EAAE,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GAAG,SAAS,CAW3I"}

package/dist/detect.js

@@ -0,0 +1,57 @@
+/**
+ * Which environment a site is running in: development, staging or production. From an explicit
+ * variable when the deployment sets one (EMDASH_ENVIRONMENT), else from the site's hostname: the
+ * hostnames configured for each environment, then common local ones, else production.
+ *
+ * Plain data, no dependencies.
+ */
+/** Hostnames that are local unless configured otherwise. */
+export const LOCAL_HOSTS = ["localhost", "127.0.0.1", "[::1]", "*.localhost", "*.local", "*.test"];
+/** The values the variable accepts for each environment. */
+const ALIASES = {
+    development: "development",
+    dev: "development",
+    local: "development",
+    staging: "staging",
+    stage: "staging",
+    preview: "staging",
+    production: "production",
+    prod: "production",
+    live: "production",
+};
+/** An environment named in the variable, or undefined (unset or not a name it knows). */
+export function environmentFromVariable(value) {
+    return value ? ALIASES[value.trim().toLowerCase()] : undefined;
+}
+/** Hostname patterns from a setting: one per line or comma separated; `*` matches any part. */
+export function parsePatterns(value) {
+    return (value ?? "")
+        .split(/[\n,]/)
+        .map((pattern) => pattern.trim().toLowerCase())
+        .filter(Boolean);
+}
+/** Whether a hostname matches a pattern such as `staging.example.com` or `*.staging.example.com`. */
+export function matchesHost(hostname, pattern) {
+    const escaped = pattern.replace(/[.+?^${}()|[\]\\]/g, "\\$&").replace(/\*/g, "[^.]+(?:\\.[^.]+)*");
+    return new RegExp(`^${escaped}$`, "i").test(hostname);
+}
+/**
+ * The environment, from the variable if it names one, else the hostname: configured production, then
+ * staging, then development hostnames, then common local ones; anything else is production.
+ */
+export function detectEnvironment({ variable, hostname, rules = {} }) {
+    const named = environmentFromVariable(variable);
+    if (named && variable)
+        return { environment: named, source: "variable", match: variable.trim() };
+    const host = hostname.toLowerCase();
+    for (const environment of ["production", "staging", "development"]) {
+        const match = parsePatterns(rules[environment]).find((pattern) => matchesHost(host, pattern));
+        if (match)
+            return { environment, source: "hostname", match };
+    }
+    const local = LOCAL_HOSTS.find((pattern) => matchesHost(host, pattern));
+    if (local)
+        return { environment: "development", source: "local hostname", match: local };
+    return { environment: "production", source: "default" };
+}
+//# sourceMappingURL=detect.js.map

package/dist/detect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detect.js","sourceRoot":"","sources":["../src/detect.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAkBH,4DAA4D;AAC5D,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;AAEnG,4DAA4D;AAC5D,MAAM,OAAO,GAAgC;IAC5C,WAAW,EAAE,aAAa;IAC1B,GAAG,EAAE,aAAa;IAClB,KAAK,EAAE,aAAa;IACpB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,SAAS;IAChB,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,YAAY;IAClB,IAAI,EAAE,YAAY;CAClB,CAAC;AAEF,yFAAyF;AACzF,MAAM,UAAU,uBAAuB,CAAC,KAAyB;IAChE,OAAO,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAChE,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,aAAa,CAAC,KAAyB;IACtD,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;SAClB,KAAK,CAAC,OAAO,CAAC;SACd,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;SAC9C,MAAM,CAAC,OAAO,CAAC,CAAC;AACnB,CAAC;AAED,qGAAqG;AACrG,MAAM,UAAU,WAAW,CAAC,QAAgB,EAAE,OAAe;IAC5D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;IACnG,OAAO,IAAI,MAAM,CAAC,IAAI,OAAO,GAAG,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACvD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,GAAG,EAAE,EAA8D;IAC/H,MAAM,KAAK,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAChD,IAAI,KAAK,IAAI,QAAQ;QAAE,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;IACjG,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IACpC,KAAK,MAAM,WAAW,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,aAAa,CAAU,EAAE,CAAC;QAC7E,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAC9F,IAAI,KAAK;YAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;IAC9D,CAAC;IACD,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACxE,IAAI,KAAK;QAAE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IACzF,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AACzD,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import type { PluginDescriptor } from "emdash";
+export declare const PLUGIN_ID = "environment-indicator";
+/**
+ * Shows which environment the site is (development, staging or production) on the EmDash dashboard.
+ * Add to `emdash({ plugins: [environmentIndicator()] })`. Set `EMDASH_ENVIRONMENT` on each deployment,
+ * or list each environment's hostnames in the plugin's settings.
+ */
+export declare function environmentIndicator(): PluginDescriptor;
+export { detectEnvironment, type Detection, type Environment } from "./detect.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAE/C,eAAO,MAAM,SAAS,0BAA0B,CAAC;AAEjD;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,gBAAgB,CA4BvD;AAED,OAAO,EAAE,iBAAiB,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,37 @@
+export const PLUGIN_ID = "environment-indicator";
+/**
+ * Shows which environment the site is (development, staging or production) on the EmDash dashboard.
+ * Add to `emdash({ plugins: [environmentIndicator()] })`. Set `EMDASH_ENVIRONMENT` on each deployment,
+ * or list each environment's hostnames in the plugin's settings.
+ */
+export function environmentIndicator() {
+    return {
+        id: PLUGIN_ID,
+        version: "0.0.0",
+        format: "standard",
+        entrypoint: "@kitaris/emdash-environment-indicator/plugin",
+        adminWidgets: [{ id: "environment", title: "Environment", size: "full" }],
+        settingsSchema: {
+            stagingHosts: {
+                type: "string",
+                label: "Staging hostnames",
+                description: "One per line. * matches any part, e.g. staging.example.com or *.staging.example.com.",
+                multiline: true,
+            },
+            productionHosts: {
+                type: "string",
+                label: "Production hostnames",
+                description: "One per line. Anything not listed as development or staging is taken as production anyway.",
+                multiline: true,
+            },
+            developmentHosts: {
+                type: "string",
+                label: "Development hostnames",
+                description: "One per line, besides local ones (localhost, *.local, *.test, ...), which are always development.",
+                multiline: true,
+            },
+        },
+    };
+}
+export { detectEnvironment } from "./detect.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,SAAS,GAAG,uBAAuB,CAAC;AAEjD;;;;GAIG;AACH,MAAM,UAAU,oBAAoB;IACnC,OAAO;QACN,EAAE,EAAE,SAAS;QACb,OAAO,EAAE,OAAO;QAChB,MAAM,EAAE,UAAU;QAClB,UAAU,EAAE,8CAA8C;QAC1D,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QACzE,cAAc,EAAE;YACf,YAAY,EAAE;gBACb,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,mBAAmB;gBAC1B,WAAW,EAAE,sFAAsF;gBACnG,SAAS,EAAE,IAAI;aACf;YACD,eAAe,EAAE;gBAChB,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,sBAAsB;gBAC7B,WAAW,EAAE,4FAA4F;gBACzG,SAAS,EAAE,IAAI;aACf;YACD,gBAAgB,EAAE;gBACjB,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,uBAAuB;gBAC9B,WAAW,EAAE,mGAAmG;gBAChH,SAAS,EAAE,IAAI;aACf;SACD;KACD,CAAC;AACH,CAAC;AAED,OAAO,EAAE,iBAAiB,EAAoC,MAAM,aAAa,CAAC"}

package/dist/plugin.d.ts

@@ -0,0 +1,8 @@
+import type { SandboxedPlugin } from "emdash/plugin";
+/**
+ * The plugin: a dashboard widget saying which environment the site is (Block Kit, so it also runs
+ * sandboxed). Hostname rules come from the plugin's settings.
+ */
+declare const plugin: SandboxedPlugin;
+export default plugin;
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAUrD;;;GAGG;AACH,QAAA,MAAM,MAAM,EAAE,eAgBb,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/plugin.js

@@ -0,0 +1,31 @@
+import { detectEnvironment } from "./detect.js";
+import { environmentWidget } from "./widget.js";
+/** The deployment's variable, where the plugin can read it (in-process; sandboxed plugins can't). */
+function variable() {
+    const env = globalThis.process?.env;
+    return env?.EMDASH_ENVIRONMENT;
+}
+/**
+ * The plugin: a dashboard widget saying which environment the site is (Block Kit, so it also runs
+ * sandboxed). Hostname rules come from the plugin's settings.
+ */
+const plugin = {
+    routes: {
+        admin: {
+            handler: async (routeCtx, ctx) => {
+                const input = routeCtx.input;
+                if (input?.type !== "page_load" || input.page !== "widget:environment")
+                    return { blocks: [] };
+                const hostname = new URL(routeCtx.request.url).hostname;
+                const rules = {
+                    development: (await ctx.settings.get("developmentHosts")) ?? undefined,
+                    staging: (await ctx.settings.get("stagingHosts")) ?? undefined,
+                    production: (await ctx.settings.get("productionHosts")) ?? undefined,
+                };
+                return { blocks: environmentWidget(detectEnvironment({ variable: variable(), hostname, rules }), hostname) };
+            },
+        },
+    },
+};
+export default plugin;
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAkB,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,qGAAqG;AACrG,SAAS,QAAQ;IAChB,MAAM,GAAG,GAAI,UAAyE,CAAC,OAAO,EAAE,GAAG,CAAC;IACpG,OAAO,GAAG,EAAE,kBAAkB,CAAC;AAChC,CAAC;AAED;;;GAGG;AACH,MAAM,MAAM,GAAoB;IAC/B,MAAM,EAAE;QACP,KAAK,EAAE;YACN,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE;gBAChC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAqD,CAAC;gBAC7E,IAAI,KAAK,EAAE,IAAI,KAAK,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,oBAAoB;oBAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;gBAC9F,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;gBACxD,MAAM,KAAK,GAAc;oBACxB,WAAW,EAAE,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAS,kBAAkB,CAAC,CAAC,IAAI,SAAS;oBAC9E,OAAO,EAAE,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAS,cAAc,CAAC,CAAC,IAAI,SAAS;oBACtE,UAAU,EAAE,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAS,iBAAiB,CAAC,CAAC,IAAI,SAAS;iBAC5E,CAAC;gBACF,OAAO,EAAE,MAAM,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC;YAC9G,CAAC;SACD;KACD;CACD,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/widget.d.ts

@@ -0,0 +1,5 @@
+import type { Block } from "@emdash-cms/blocks";
+import type { Detection } from "./detect.ts";
+/** The dashboard widget: which environment this is, and how that was decided. */
+export declare function environmentWidget(detection: Detection, hostname: string): Block[];
+//# sourceMappingURL=widget.d.ts.map

package/dist/widget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../src/widget.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,SAAS,EAAe,MAAM,aAAa,CAAC;AA4B1D,iFAAiF;AACjF,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,GAAG,KAAK,EAAE,CAKjF"}

package/dist/widget.js

@@ -0,0 +1,30 @@
+const TITLES = { development: "Development", staging: "Staging", production: "Production" };
+const DESCRIPTIONS = {
+    development: "Local build. Nothing you do here reaches the live site.",
+    staging: "Pre-release copy for testing before you deploy.",
+    production: "Live site. Published changes are public immediately.",
+};
+/** Banner variants by environment: production stands out, as the one to be careful with. */
+const VARIANTS = { development: "default", staging: "alert", production: "error" };
+/** How the environment was decided, for developers: what matched, and where to change it. */
+function sourceText({ environment, source, match }, host) {
+    const matched = (where) => (match && match !== host ? `${host} matched ${match} in ${where}.` : `${host} is in ${where}.`);
+    switch (source) {
+        case "variable":
+            return `Set by EMDASH_ENVIRONMENT=${match}.`;
+        case "hostname":
+            return matched(`${TITLES[environment]} hostnames`);
+        case "local hostname":
+            return matched("the common local hostnames");
+        case "default":
+            return `${host} matched no rule, so it defaults to production. Set EMDASH_ENVIRONMENT or add the hostname in the plugin's settings.`;
+    }
+}
+/** The dashboard widget: which environment this is, and how that was decided. */
+export function environmentWidget(detection, hostname) {
+    return [
+        { type: "banner", title: TITLES[detection.environment], description: DESCRIPTIONS[detection.environment], variant: VARIANTS[detection.environment] },
+        { type: "context", text: sourceText(detection, hostname) },
+    ];
+}
+//# sourceMappingURL=widget.js.map

package/dist/widget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"widget.js","sourceRoot":"","sources":["../src/widget.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,GAAgC,EAAE,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,CAAC;AAEzH,MAAM,YAAY,GAAgC;IACjD,WAAW,EAAE,yDAAyD;IACtE,OAAO,EAAE,iDAAiD;IAC1D,UAAU,EAAE,sDAAsD;CAClE,CAAC;AAEF,4FAA4F;AAC5F,MAAM,QAAQ,GAAuD,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;AAEvI,6FAA6F;AAC7F,SAAS,UAAU,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAa,EAAE,IAAY;IAC1E,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,YAAY,KAAK,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,UAAU,KAAK,GAAG,CAAC,CAAC;IACnI,QAAQ,MAAM,EAAE,CAAC;QAChB,KAAK,UAAU;YACd,OAAO,6BAA6B,KAAK,GAAG,CAAC;QAC9C,KAAK,UAAU;YACd,OAAO,OAAO,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACpD,KAAK,gBAAgB;YACpB,OAAO,OAAO,CAAC,4BAA4B,CAAC,CAAC;QAC9C,KAAK,SAAS;YACb,OAAO,GAAG,IAAI,sHAAsH,CAAC;IACvI,CAAC;AACF,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,iBAAiB,CAAC,SAAoB,EAAE,QAAgB;IACvE,OAAO;QACN,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE;QACpJ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE;KAC1D,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@kitaris/emdash-environment-indicator",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "An EmDash plugin that shows which environment a site is (development, staging or production) on the dashboard.",
+  "license": "GPL-2.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/builtnorth/emdash-plugins.git",
+    "directory": "packages/environment-indicator"
+  },
+  "keywords": [
+    "emdash",
+    "emdash-plugin",
+    "environment",
+    "staging"
+  ],
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./plugin": {
+      "types": "./dist/plugin.d.ts",
+      "default": "./dist/plugin.js"
+    }
+  },
+  "peerDependencies": {
+    "@emdash-cms/blocks": "^1.3.0",
+    "emdash": "^1.3.0"
+  },
+  "devDependencies": {
+    "@emdash-cms/blocks": "1.3.1",
+    "emdash": "1.3.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "node ../../scripts/build-package.mjs",
+    "test": "vitest run",
+    "typecheck": "tsc -p ."
+  }
 }