@builder.io/sdk-svelte 0.7.0 → 0.7.1-0

package/src/functions/get-content/types.ts

@@ -8,12 +8,44 @@ export interface GetContentOptions {
   /** Number of items to fetch. Default is 1 */
   limit?: number;
 
-  /** User attributes to target on, such as { urlPath: '/foo', device: 'mobile', ...etc } */
+  /**
+   * Use to specify an offset for pagination of results. The default is 0.
+   */
+  offset?: number;
+
+  /**
+   * User attribute key value pairs to be used for targeting
+   * https://www.builder.io/c/docs/custom-targeting-attributes
+   *
+   * e.g.
+   * ```js
+   * userAttributes: {
+   *   urlPath: '/',
+   *   returnVisitor: true,
+   *   device: 'mobile'
+   * }
+   * ```
+   */
   userAttributes?: (Record<string, string> & {
     urlPath?: string;
   }) | null;
 
-  /** Custom query */
+  /**
+   * Mongodb style query of your data. E.g.:
+   *
+   * ```js
+   * query: {
+   *  id: 'abc123',
+   *  data: {
+   *    myCustomField: { $gt: 20 },
+   *  }
+   * }
+   * ```
+   *
+   * See more info on MongoDB's query operators and format.
+   *
+   * @see {@link https://docs.mongodb.com/manual/reference/operator/query/}
+   */
   query?: Record<string, any>;
 
   /**
@@ -38,7 +70,7 @@ export interface GetContentOptions {
   canTrack?: boolean;
 
   /**
-   * Include references in the response. Defaults to `true`.
+   * Include content of references in the response. Defaults to `true`.
    * @deprecated use `enrich` instead
    */
   includeRefs?: boolean;
@@ -59,4 +91,70 @@ export interface GetContentOptions {
    * Defaults to `v3`.
    */
   apiVersion?: 'v2' | 'v3';
+
+  /**
+   * Only include these fields.
+   * Note: 'omit' takes precedence over 'fields'
+   *
+   * @example
+   * ```
+   * fields: 'id, name, data.customField'
+   * ```
+   */
+  fields?: string;
+
+  /**
+   * Omit only these fields.
+   * Note: 'omit' takes precedence over 'fields'
+   *
+   * @example
+   * ```
+   * omit: 'data.bigField,data.blocks'
+   * ```
+   */
+  omit?: string;
+
+  /**
+   * Seconds to cache content. Sets the max-age of the cache-control header
+   * response header.
+   *
+   * Use a higher value for better performance, lower for content that will change more frequently
+   *
+   * @see {@link https://www.builder.io/c/docs/query-api#__next:~:text=%26includeRefs%3Dtrue-,cacheSeconds,-No}
+   */
+  cacheSeconds?: number;
+
+  /**
+   * Builder.io uses stale-while-revalidate caching at the CDN level. This means we always serve
+   * from edge cache and update caches in the background for maximum possible performance. This also
+   * means that the more frequently content is requested, the more fresh it will be. The longest we
+   * will ever hold something in stale cache is 1 day by default, and you can set this to be shorter
+   * yourself as well. We suggest keeping this high unless you have content that must change rapidly
+   * and gets very little traffic.
+   *
+   * @see {@link https://www.fastly.com/blog/prevent-application-network-instability-serve-stale-content}
+   */
+  staleCacheSeconds?: number;
+
+  /**
+   * Property to order results by.
+   * Use 1 for ascending and -1 for descending.
+   *
+   * The key is what you're sorting on, so the following example sorts by createdDate
+   * and because the value is 1, the sort is ascending.
+   *
+   * @example
+   * ```
+   * createdDate: 1
+   * ```
+   */
+  sort?: {
+    [key: string]: 1 | -1;
+  };
+
+  /**
+   * Include content entries in a response that are still in
+   * draft mode and un-archived. Default is false.
+   */
+  includeUnpublished?: boolean;
 }

package/src/functions/is-edge-runtime.ts

@@ -1,9 +1,9 @@
 import { isBrowser } from './is-browser.js';
+import { isNodeRuntime } from './is-node-runtime.js';
 
 /**
  * Identifies edge runtimes (edge, workers, serverless, etc.)
  */
 export function isEdgeRuntime(): boolean {
-  const hasNode = () => typeof process !== 'undefined' && process?.versions?.node;
-  return !isBrowser() && !hasNode();
+  return !isBrowser() && !isNodeRuntime();
 }

package/src/functions/is-node-runtime.ts

@@ -0,0 +1,8 @@
+import { checkIsDefined } from '../helpers/nullable';
+
+/**
+ * Identifies node runtime
+ */
+export function isNodeRuntime(): boolean {
+  return typeof process !== 'undefined' && checkIsDefined(process?.versions?.node);
+}