@tandem-language-exchange/content-store 1.1.0 → 1.1.1

package/dist/index-DxoMnE4K.d.ts

@@ -0,0 +1,92 @@
+type CMSProvider = 'contentful' | 'sanity';
+interface S3Config {
+    bucket: string;
+    region: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+}
+
+declare class ContentStore {
+    private client;
+    private bucket;
+    constructor(cfg: S3Config);
+    /** {cms}-{contentType}-{timestamp}.json */
+    buildVersionedKey(cms: string, contentType: string, timestamp: number): string;
+    /** {cms}-{contentType}.json  (always points at the latest version) */
+    buildLatestKey(cms: string, contentType: string): string;
+    upload(key: string, data: unknown): Promise<string>;
+    download(key: string): Promise<unknown>;
+    /**
+     * Copies a versioned object to the "latest" key so that it always reflects
+     * the most recent sync while older timestamped versions are retained.
+     */
+    copyToLatest(sourceKey: string, cms: string, contentType: string): Promise<string>;
+}
+
+interface BundleInfo {
+    [key: string]: string;
+}
+interface BundleItem {
+    [key: string]: any;
+}
+interface FetchBundlesOptions {
+    cms: CMSProvider;
+    contentTypes: string[];
+}
+interface QueryOptions {
+    /**
+     * Filter items by matching property values (exact equality, or array for IN).
+     * Keys may use dot notation for nested paths, e.g. `{ 'meta._id': 'abc' }` matches
+     * `item.meta._id`.
+     *
+     * Contentful-style operators on the path (before `[`):
+     * - `{ 'field[exists]': true }` — field is present and non-empty (not null, undefined,
+     *   `''`, `[]`, or `{}`).
+     * - `{ 'field[exists]': false }` — field is missing or empty (same emptiness rules).
+     * Nested paths work, e.g. `{ 'blocks.hero[exists]': false }`.
+     */
+    fields?: Record<string, unknown>;
+    /**
+     * Properties to include in each result object. Omit to return all properties.
+     * Keys may use dot notation; nested segments become nested objects in the result,
+     * e.g. `['slug', 'meta._updatedAt']` → `{ slug, meta: { _updatedAt } }`.
+     */
+    select?: string[];
+    /** Maximum number of items to return. */
+    limit?: number;
+    /**
+     * How many levels deep to return.
+     *  - 1 = the item's own scalar properties only; nested objects/refs are nulled.
+     *  - 2 = the item including its direct references; refs inside those are nulled.
+     *  - 3 = three levels deep, and so on.
+     *  - Omit to return the full depth.
+     */
+    include?: number;
+}
+/**
+ * Trims nested object depth.
+ *
+ * `remaining` represents how many levels the current object is allowed.
+ *  - Scalar properties are always kept.
+ *  - Nested objects / arrays-of-objects consume one level. When `remaining`
+ *    drops to 1 they are replaced with `null` (no budget left for refs).
+ */
+declare function trimDepth(value: unknown, remaining: number): unknown;
+/**
+ * Downloads the latest bundles from S3 and writes them as JSON files to `outputDir`.
+ *
+ * @returns A map of contentType to absolute file path.
+ */
+declare function fetchBundles(store: ContentStore, outputDir: string, options: FetchBundlesOptions): Promise<Record<string, string>>;
+/**
+ * Queries a previously fetched bundle from the local filesystem.
+ */
+declare function queryBundle(outputDir: string, cms: CMSProvider, contentType: string, options?: QueryOptions): Promise<unknown[]>;
+
+interface SDKConfig {
+    s3: S3Config;
+    /** Directory where bundle JSON files are saved on the local filesystem. */
+    outputDir: string;
+}
+
+export { type BundleInfo as B, type CMSProvider as C, type FetchBundlesOptions as F, type QueryOptions as Q, type SDKConfig as S, type BundleItem as a, ContentStore as b, type S3Config as c, fetchBundles as f, queryBundle as q, trimDepth as t };

package/node.d.ts

@@ -0,0 +1 @@
+export * from './dist/node.js';

package/node.js

@@ -0,0 +1,5 @@
+/**
+ * Re-export for `@tandem-language-exchange/content-store/node`.
+ * Root file so resolvers that ignore package "exports" still resolve.
+ */
+export * from './dist/node.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tandem-language-exchange/content-store",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,13 +11,16 @@
       "default": "./dist/index.js"
     },
     "./node": {
-      "types": "./dist/node.d.ts",
-      "import": "./dist/node.js",
-      "default": "./dist/node.js"
+      "types": "./node.d.ts",
+      "import": "./node.js",
+      "default": "./node.js"
     }
   },
   "files": [
+    "node.js",
+    "node.d.ts",
     "dist/index.*",
+    "dist/index-*.d.ts",
     "dist/node.*",
     "dist/sdk/",
     "dist/client/",