@headroom-cms/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/astro.js

@@ -304,7 +304,10 @@ var HeadroomClient = class {
     const res = await fetch(url, {
       method: "POST",
       headers,
-      body: JSON.stringify({ fields: options.fields })
+      body: JSON.stringify({
+        fields: options.fields,
+        ...options.relationships && { relationships: options.relationships }
+      })
     });
     if (!res.ok) {
       let code = "UNKNOWN";

package/dist/index.cjs

@@ -332,7 +332,10 @@ var HeadroomClient = class {
     const res = await fetch(url, {
       method: "POST",
       headers,
-      body: JSON.stringify({ fields: options.fields })
+      body: JSON.stringify({
+        fields: options.fields,
+        ...options.relationships && { relationships: options.relationships }
+      })
     });
     if (!res.ok) {
       let code = "UNKNOWN";

package/dist/index.d.cts

@@ -61,6 +61,12 @@ interface ContentMetadata {
     coverUrl?: string;
     coverMediaId?: string;
     lastPublishedAt?: number;
+    /** Set to "submission" for submission content, omitted for regular content */
+    mode?: string;
+    /** Site user ID of the submitter (submissions only) */
+    siteUserId?: string;
+    /** Submission field values (submissions only) */
+    fields?: Record<string, unknown>;
 }
 interface ContentItem extends ContentMetadata {
     body?: {
@@ -159,6 +165,10 @@ interface SubmitOptions {
     fields: Record<string, unknown>;
     /** Optional site user session token (adds X-Headroom-Session header) */
     sessionToken?: string;
+    /** Optional relationships to associate with the submission */
+    relationships?: Record<string, {
+        contentId: string;
+    }[]>;
 }
 /** Result returned from a successful submission. */
 interface SubmitResult {
@@ -260,8 +270,8 @@ declare class HeadroomClient {
         cursor?: string;
         before?: number;
         after?: number;
-        /** Sort order: "published_desc" (default), "published_asc", "title_asc", "title_desc" */
-        sort?: "published_desc" | "published_asc" | "title_asc" | "title_desc";
+        /** Sort order. For regular queries: "published_desc" (default), "published_asc", "title_asc", "title_desc". For relatedTo queries: "created_desc" (default), "created_asc". */
+        sort?: "published_desc" | "published_asc" | "title_asc" | "title_desc" | "created_desc" | "created_asc";
         /** Find content that has a relationship pointing to this content ID (reverse query) */
         relatedTo?: string;
         /** Filter reverse query to a specific relationship field name */

package/dist/index.d.ts

@@ -61,6 +61,12 @@ interface ContentMetadata {
     coverUrl?: string;
     coverMediaId?: string;
     lastPublishedAt?: number;
+    /** Set to "submission" for submission content, omitted for regular content */
+    mode?: string;
+    /** Site user ID of the submitter (submissions only) */
+    siteUserId?: string;
+    /** Submission field values (submissions only) */
+    fields?: Record<string, unknown>;
 }
 interface ContentItem extends ContentMetadata {
     body?: {
@@ -159,6 +165,10 @@ interface SubmitOptions {
     fields: Record<string, unknown>;
     /** Optional site user session token (adds X-Headroom-Session header) */
     sessionToken?: string;
+    /** Optional relationships to associate with the submission */
+    relationships?: Record<string, {
+        contentId: string;
+    }[]>;
 }
 /** Result returned from a successful submission. */
 interface SubmitResult {
@@ -260,8 +270,8 @@ declare class HeadroomClient {
         cursor?: string;
         before?: number;
         after?: number;
-        /** Sort order: "published_desc" (default), "published_asc", "title_asc", "title_desc" */
-        sort?: "published_desc" | "published_asc" | "title_asc" | "title_desc";
+        /** Sort order. For regular queries: "published_desc" (default), "published_asc", "title_asc", "title_desc". For relatedTo queries: "created_desc" (default), "created_asc". */
+        sort?: "published_desc" | "published_asc" | "title_asc" | "title_desc" | "created_desc" | "created_asc";
         /** Find content that has a relationship pointing to this content ID (reverse query) */
         relatedTo?: string;
         /** Filter reverse query to a specific relationship field name */

package/dist/index.js

@@ -304,7 +304,10 @@ var HeadroomClient = class {
     const res = await fetch(url, {
       method: "POST",
       headers,
-      body: JSON.stringify({ fields: options.fields })
+      body: JSON.stringify({
+        fields: options.fields,
+        ...options.relationships && { relationships: options.relationships }
+      })
     });
     if (!res.ok) {
       let code = "UNKNOWN";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@headroom-cms/api",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "type": "module",
   "exports": {
     ".": {
@@ -38,13 +38,6 @@
     "dist",
     "blocks"
   ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "typecheck": "tsc --noEmit"
-  },
   "peerDependencies": {
     "astro": ">=5",
     "next": ">=14",
@@ -78,5 +71,12 @@
     "tsup": "~8.5.0",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
   }
-}
+}