@headroom-cms/admin-api 0.1.5 → 0.1.7

package/LICENSE

@@ -0,0 +1,142 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software
+to do everything you might do with the software that would
+otherwise infringe the licensor's copyright in it for any
+permitted purpose. However, you may only distribute the
+software according to [Distribution License](#distribution-license)
+and make changes or new works based on the software according to
+[Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to
+distribute copies of the software. Your license to distribute
+covers distributing the software with changes and new works
+permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software. For example:
+
+> Required Notice: Copyright Cykod LLC (https://cykod.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software
+that covers patent claims the licensor can license, or
+becomes able to license, that you would infringe by using
+the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for
+the benefit of public knowledge, personal study, private
+entertainment, hobby projects, amateur pursuits, or
+religious observance, without any anticipated commercial
+application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution,
+public research organization, public safety or health
+organization, environmental protection organization, or
+government institution is use for a permitted purpose
+regardless of the source of funding or obligations
+resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any
+of your licenses to anyone else, or prevent the licensor
+from granting licenses to anyone else. These terms do not
+imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes
+or contributes to infringement of any patent, your patent
+license for the software granted under these terms ends
+immediately. If your company makes such a claim, your
+patent license ends immediately for work on behalf of
+your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the
+software not covered by your licenses, your licenses can
+nonetheless continue if you come into full compliance with
+these terms, and take practical steps to correct past
+violations, within 32 days of receiving notice. Otherwise,
+all your licenses end immediately.
+
+## No Liability
+
+As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be
+liable to you for any damages arising out of these terms
+or the use or nature of the software, under any kind of
+legal claim.
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor
+makes available under these terms.
+
+**You** refers to the individual or entity agreeing to
+these terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control
+of, or are under common control with that organization.
+**Control** means ownership of substantially all the assets
+of an entity, or the power to direct its management and
+policies by vote, contract, or otherwise. Control can be
+direct or indirect.
+
+**Your licenses** are all the licenses granted to you for
+the software under these terms.
+
+**Use** means anything you do with the software requiring
+one of your licenses.
+
+---
+
+## Commercial License
+
+For commercial use of Headroom CMS, a commercial license is
+required at $5/month.
+
+To purchase a commercial license, contact: headroom@cykod.com

package/dist/index.cjs

@@ -236,6 +236,7 @@ var HeadroomAdminClient = class {
     if (params?.status) qs.set("status", params.status);
     if (params?.sort) qs.set("sort", params.sort);
     if (params?.relatedTo) qs.set("relatedTo", params.relatedTo);
+    if (params?.relField) qs.set("relField", params.relField);
     if (params?.limit) qs.set("limit", String(params.limit));
     if (params?.cursor) qs.set("cursor", params.cursor);
     const q = qs.toString();

package/dist/index.d.cts

@@ -325,6 +325,8 @@ interface components {
 
 type Site = components["schemas"]["Site"] & {
     auth?: SiteAuthConfig;
+    fromEmail?: string;
+    fromName?: string;
 };
 type SiteAdmin = components["schemas"]["SiteAdmin"];
 type Collection = components["schemas"]["Collection"] & {
@@ -396,7 +398,6 @@ interface SiteAuthConfig {
     sessionTtl: number;
     allowSignup: boolean;
     otpRateLimit?: number;
-    fromName?: string;
     emailSubject?: string;
     emailBody?: string;
     emailTextBody?: string;
@@ -514,6 +515,7 @@ interface ContentListParams {
     status?: "draft" | "published" | "changed" | "unpublished" | "scheduled";
     sort?: string;
     relatedTo?: string;
+    relField?: string;
     limit?: number;
     cursor?: string;
 }
@@ -576,6 +578,8 @@ declare class HeadroomAdminClient {
     updateSite(host: string, data: {
         name?: string;
         status?: string;
+        fromEmail?: string;
+        fromName?: string;
     }): Promise<Site>;
     deleteSite(host: string): Promise<void>;
     updateSiteAdmins(host: string, admins: SiteAdmin[]): Promise<void>;

package/dist/index.d.ts

@@ -325,6 +325,8 @@ interface components {
 
 type Site = components["schemas"]["Site"] & {
     auth?: SiteAuthConfig;
+    fromEmail?: string;
+    fromName?: string;
 };
 type SiteAdmin = components["schemas"]["SiteAdmin"];
 type Collection = components["schemas"]["Collection"] & {
@@ -396,7 +398,6 @@ interface SiteAuthConfig {
     sessionTtl: number;
     allowSignup: boolean;
     otpRateLimit?: number;
-    fromName?: string;
     emailSubject?: string;
     emailBody?: string;
     emailTextBody?: string;
@@ -514,6 +515,7 @@ interface ContentListParams {
     status?: "draft" | "published" | "changed" | "unpublished" | "scheduled";
     sort?: string;
     relatedTo?: string;
+    relField?: string;
     limit?: number;
     cursor?: string;
 }
@@ -576,6 +578,8 @@ declare class HeadroomAdminClient {
     updateSite(host: string, data: {
         name?: string;
         status?: string;
+        fromEmail?: string;
+        fromName?: string;
     }): Promise<Site>;
     deleteSite(host: string): Promise<void>;
     updateSiteAdmins(host: string, admins: SiteAdmin[]): Promise<void>;

package/dist/index.js

@@ -198,6 +198,7 @@ var HeadroomAdminClient = class {
     if (params?.status) qs.set("status", params.status);
     if (params?.sort) qs.set("sort", params.sort);
     if (params?.relatedTo) qs.set("relatedTo", params.relatedTo);
+    if (params?.relField) qs.set("relField", params.relField);
     if (params?.limit) qs.set("limit", String(params.limit));
     if (params?.cursor) qs.set("cursor", params.cursor);
     const q = qs.toString();

package/dist/node.d.cts

@@ -316,6 +316,8 @@ interface components {
 
 type Site = components["schemas"]["Site"] & {
     auth?: SiteAuthConfig;
+    fromEmail?: string;
+    fromName?: string;
 };
 type SiteAdmin = components["schemas"]["SiteAdmin"];
 type Collection = components["schemas"]["Collection"] & {
@@ -381,7 +383,6 @@ interface SiteAuthConfig {
     sessionTtl: number;
     allowSignup: boolean;
     otpRateLimit?: number;
-    fromName?: string;
     emailSubject?: string;
     emailBody?: string;
     emailTextBody?: string;
@@ -499,6 +500,7 @@ interface ContentListParams {
     status?: "draft" | "published" | "changed" | "unpublished" | "scheduled";
     sort?: string;
     relatedTo?: string;
+    relField?: string;
     limit?: number;
     cursor?: string;
 }
@@ -561,6 +563,8 @@ declare class HeadroomAdminClient {
     updateSite(host: string, data: {
         name?: string;
         status?: string;
+        fromEmail?: string;
+        fromName?: string;
     }): Promise<Site>;
     deleteSite(host: string): Promise<void>;
     updateSiteAdmins(host: string, admins: SiteAdmin[]): Promise<void>;

package/dist/node.d.ts

@@ -316,6 +316,8 @@ interface components {
 
 type Site = components["schemas"]["Site"] & {
     auth?: SiteAuthConfig;
+    fromEmail?: string;
+    fromName?: string;
 };
 type SiteAdmin = components["schemas"]["SiteAdmin"];
 type Collection = components["schemas"]["Collection"] & {
@@ -381,7 +383,6 @@ interface SiteAuthConfig {
     sessionTtl: number;
     allowSignup: boolean;
     otpRateLimit?: number;
-    fromName?: string;
     emailSubject?: string;
     emailBody?: string;
     emailTextBody?: string;
@@ -499,6 +500,7 @@ interface ContentListParams {
     status?: "draft" | "published" | "changed" | "unpublished" | "scheduled";
     sort?: string;
     relatedTo?: string;
+    relField?: string;
     limit?: number;
     cursor?: string;
 }
@@ -561,6 +563,8 @@ declare class HeadroomAdminClient {
     updateSite(host: string, data: {
         name?: string;
         status?: string;
+        fromEmail?: string;
+        fromName?: string;
     }): Promise<Site>;
     deleteSite(host: string): Promise<void>;
     updateSiteAdmins(host: string, admins: SiteAdmin[]): Promise<void>;

package/dist/seed.d.cts

@@ -305,6 +305,8 @@ interface components {
 
 type Site = components["schemas"]["Site"] & {
     auth?: SiteAuthConfig;
+    fromEmail?: string;
+    fromName?: string;
 };
 type Collection = components["schemas"]["Collection"] & {
     relationships?: RelationshipDef[];
@@ -337,7 +339,6 @@ interface SiteAuthConfig {
     sessionTtl: number;
     allowSignup: boolean;
     otpRateLimit?: number;
-    fromName?: string;
     emailSubject?: string;
     emailBody?: string;
     emailTextBody?: string;

package/dist/seed.d.ts

@@ -305,6 +305,8 @@ interface components {
 
 type Site = components["schemas"]["Site"] & {
     auth?: SiteAuthConfig;
+    fromEmail?: string;
+    fromName?: string;
 };
 type Collection = components["schemas"]["Collection"] & {
     relationships?: RelationshipDef[];
@@ -337,7 +339,6 @@ interface SiteAuthConfig {
     sessionTtl: number;
     allowSignup: boolean;
     otpRateLimit?: number;
-    fromName?: string;
     emailSubject?: string;
     emailBody?: string;
     emailTextBody?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@headroom-cms/admin-api",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "type": "module",
   "exports": {
     ".": {
@@ -30,14 +30,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "typecheck": "tsc --noEmit",
-    "generate:types": "bash scripts/generate-types.sh"
-  },
   "devDependencies": {
     "@types/node": "~24.10.13",
     "@vitest/coverage-v8": "^4.0.18",
@@ -53,5 +45,13 @@
     "amazon-cognito-identity-js": {
       "optional": true
     }
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "generate:types": "bash scripts/generate-types.sh"
   }
-}
+}